@rbxts/types 1.0.917 → 1.0.919
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 +254 -15
- package/include/generated/PluginSecurity.d.ts +166 -44
- package/include/generated/enums.d.ts +1590 -1347
- 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;
|
|
@@ -130,6 +131,7 @@ interface Services {
|
|
|
130
131
|
ModerationService: ModerationService;
|
|
131
132
|
OmniRecommendationsService: OmniRecommendationsService;
|
|
132
133
|
OpenCloudService: OpenCloudService;
|
|
134
|
+
Packages: Packages;
|
|
133
135
|
PackageUIService: PackageUIService;
|
|
134
136
|
PartyEmulatorService: PartyEmulatorService;
|
|
135
137
|
PatchBundlerFileWatch: PatchBundlerFileWatch;
|
|
@@ -2250,7 +2252,7 @@ interface Instance extends RBXObject {
|
|
|
2250
2252
|
*/
|
|
2251
2253
|
Parent: Instance | undefined;
|
|
2252
2254
|
/**
|
|
2253
|
-
*
|
|
2255
|
+
* When enabled, the instance can only access abilities in its `Capabilities` list.
|
|
2254
2256
|
*
|
|
2255
2257
|
* - **ThreadSafety**: ReadSafe
|
|
2256
2258
|
* - **Tags**: NotReplicated
|
|
@@ -2577,7 +2579,7 @@ interface Instance extends RBXObject {
|
|
|
2577
2579
|
WaitForChild(this: Instance, childName: string | number): Instance;
|
|
2578
2580
|
WaitForChild(this: Instance, childName: string | number, timeOut: number): Instance | undefined;
|
|
2579
2581
|
/**
|
|
2580
|
-
* Fires when the `Instance.Parent` property of
|
|
2582
|
+
* Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
|
|
2581
2583
|
*
|
|
2582
2584
|
* - **ThreadSafety**: Unsafe
|
|
2583
2585
|
*
|
|
@@ -9403,6 +9405,12 @@ interface RootImportData extends BaseImportData {
|
|
|
9403
9405
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#ValidateUgcBody)
|
|
9404
9406
|
*/
|
|
9405
9407
|
ValidateUgcBody: boolean;
|
|
9408
|
+
/**
|
|
9409
|
+
* - **ThreadSafety**: ReadSafe
|
|
9410
|
+
*
|
|
9411
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#VersionedAssetId)
|
|
9412
|
+
*/
|
|
9413
|
+
VersionedAssetId: number;
|
|
9406
9414
|
/**
|
|
9407
9415
|
* - **ThreadSafety**: ReadSafe
|
|
9408
9416
|
*
|
|
@@ -11916,6 +11924,21 @@ interface CloudCRUDService extends Instance {
|
|
|
11916
11924
|
*/
|
|
11917
11925
|
readonly _nominal_CloudCRUDService: unique symbol;
|
|
11918
11926
|
}
|
|
11927
|
+
/**
|
|
11928
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11929
|
+
*
|
|
11930
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CloudExecutionService)
|
|
11931
|
+
*/
|
|
11932
|
+
interface CloudExecutionService extends Instance {
|
|
11933
|
+
/**
|
|
11934
|
+
* **DO NOT USE!**
|
|
11935
|
+
*
|
|
11936
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11937
|
+
* @hidden
|
|
11938
|
+
* @deprecated
|
|
11939
|
+
*/
|
|
11940
|
+
readonly _nominal_CloudExecutionService: unique symbol;
|
|
11941
|
+
}
|
|
11919
11942
|
/**
|
|
11920
11943
|
* Renders realistic clouds that drift slowly across the sky.
|
|
11921
11944
|
*
|
|
@@ -15669,8 +15692,6 @@ interface DataStoreSetOptions extends Instance {
|
|
|
15669
15692
|
/**
|
|
15670
15693
|
* Allows scheduling the guaranteed destruction of an object without yielding.
|
|
15671
15694
|
*
|
|
15672
|
-
* .
|
|
15673
|
-
*
|
|
15674
15695
|
* - **Tags**: NotCreatable, Service
|
|
15675
15696
|
*
|
|
15676
15697
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Debris)
|
|
@@ -15691,8 +15712,6 @@ interface Debris extends Instance {
|
|
|
15691
15712
|
*
|
|
15692
15713
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Debris#AddItem)
|
|
15693
15714
|
* @param this Allows scheduling the guaranteed destruction of an object without yielding.
|
|
15694
|
-
*
|
|
15695
|
-
* .
|
|
15696
15715
|
* @param item The `Instance` to add to `Debris`.
|
|
15697
15716
|
* @param lifetime Number of seconds before the `Instance` should be destroyed.
|
|
15698
15717
|
*/
|
|
@@ -17586,6 +17605,8 @@ interface Folder extends Instance {
|
|
|
17586
17605
|
readonly _nominal_Folder: unique symbol;
|
|
17587
17606
|
}
|
|
17588
17607
|
/**
|
|
17608
|
+
* A container that stores `ProceduralModel` generation results.
|
|
17609
|
+
*
|
|
17589
17610
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder)
|
|
17590
17611
|
*/
|
|
17591
17612
|
interface GeneratedFolder extends Folder {
|
|
@@ -17598,10 +17619,12 @@ interface GeneratedFolder extends Folder {
|
|
|
17598
17619
|
*/
|
|
17599
17620
|
readonly _nominal_GeneratedFolder: unique symbol;
|
|
17600
17621
|
/**
|
|
17622
|
+
* Specifies which part within the `GeneratedFolder` should be set as the `PrimaryPart` of the `ProceduralModel`.
|
|
17623
|
+
*
|
|
17601
17624
|
* - **ThreadSafety**: Unsafe
|
|
17602
17625
|
*
|
|
17603
17626
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
|
|
17604
|
-
* @param this
|
|
17627
|
+
* @param this A container that stores `ProceduralModel` generation results.
|
|
17605
17628
|
* @param part
|
|
17606
17629
|
*/
|
|
17607
17630
|
SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
|
|
@@ -23445,7 +23468,7 @@ interface Humanoid extends Instance {
|
|
|
23445
23468
|
*/
|
|
23446
23469
|
RightLeg: BasePart | undefined;
|
|
23447
23470
|
/**
|
|
23448
|
-
* A reference to the humanoid's
|
|
23471
|
+
* A reference to the humanoid's `HumanoidRootPart` object.
|
|
23449
23472
|
*
|
|
23450
23473
|
* - **ThreadSafety**: ReadSafe
|
|
23451
23474
|
* - **Tags**: NotReplicated
|
|
@@ -23860,7 +23883,7 @@ interface Humanoid extends Instance {
|
|
|
23860
23883
|
*/
|
|
23861
23884
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23862
23885
|
/**
|
|
23863
|
-
* Makes the character's look match that of the passed in `HumanoidDescription`.
|
|
23886
|
+
* 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.
|
|
23864
23887
|
*
|
|
23865
23888
|
* - **ThreadSafety**: Unsafe
|
|
23866
23889
|
* - **Tags**: Yields
|
|
@@ -28224,6 +28247,18 @@ interface MLService extends Instance {
|
|
|
28224
28247
|
* @deprecated
|
|
28225
28248
|
*/
|
|
28226
28249
|
readonly _nominal_MLService: unique symbol;
|
|
28250
|
+
/**
|
|
28251
|
+
* - **ThreadSafety**: Unsafe
|
|
28252
|
+
*
|
|
28253
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#IsPostProcessReady)
|
|
28254
|
+
*/
|
|
28255
|
+
IsPostProcessReady(this: MLService): boolean;
|
|
28256
|
+
/**
|
|
28257
|
+
* - **ThreadSafety**: Unsafe
|
|
28258
|
+
*
|
|
28259
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#SetPostProcessEnabled)
|
|
28260
|
+
*/
|
|
28261
|
+
SetPostProcessEnabled(this: MLService, enabled: boolean): void;
|
|
28227
28262
|
/**
|
|
28228
28263
|
* - **ThreadSafety**: Unsafe
|
|
28229
28264
|
* - **Tags**: Yields
|
|
@@ -28233,6 +28268,13 @@ interface MLService extends Instance {
|
|
|
28233
28268
|
* @param assetId
|
|
28234
28269
|
*/
|
|
28235
28270
|
CreateSessionAsync(this: MLService, assetId: string): MLSession;
|
|
28271
|
+
/**
|
|
28272
|
+
* - **ThreadSafety**: Unsafe
|
|
28273
|
+
* - **Tags**: Yields
|
|
28274
|
+
*
|
|
28275
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MLService#LoadPostProcessModelAsync)
|
|
28276
|
+
*/
|
|
28277
|
+
LoadPostProcessModelAsync(this: MLService, assetId: number): void;
|
|
28236
28278
|
}
|
|
28237
28279
|
/**
|
|
28238
28280
|
* Describes the appearance of a makeup item for the `HumanoidDescription`.
|
|
@@ -28439,6 +28481,8 @@ interface MarketplaceService extends Instance {
|
|
|
28439
28481
|
*/
|
|
28440
28482
|
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number): void;
|
|
28441
28483
|
/**
|
|
28484
|
+
* **Deprecated:** This method has been superseded by `PromptRobloxSubscriptionPurchase()`.
|
|
28485
|
+
*
|
|
28442
28486
|
* Prompts a user to purchase Roblox Premium.
|
|
28443
28487
|
*
|
|
28444
28488
|
* - **ThreadSafety**: Unsafe
|
|
@@ -31593,6 +31637,12 @@ interface Terrain extends BasePart {
|
|
|
31593
31637
|
* @param material The material with which the wedge will be filled.
|
|
31594
31638
|
*/
|
|
31595
31639
|
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
31640
|
+
/**
|
|
31641
|
+
* - **ThreadSafety**: Unsafe
|
|
31642
|
+
*
|
|
31643
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetBaseMaterialSlotIndex)
|
|
31644
|
+
*/
|
|
31645
|
+
GetBaseMaterialSlotIndex(this: Terrain, baseMaterial: CastsToEnum<Enum.Material>): number | undefined;
|
|
31596
31646
|
/**
|
|
31597
31647
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31598
31648
|
*
|
|
@@ -31610,6 +31660,12 @@ interface Terrain extends BasePart {
|
|
|
31610
31660
|
* @deprecated
|
|
31611
31661
|
*/
|
|
31612
31662
|
GetCell(this: Terrain, x: number, y: number, z: number): unknown;
|
|
31663
|
+
/**
|
|
31664
|
+
* - **ThreadSafety**: Unsafe
|
|
31665
|
+
*
|
|
31666
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetFirstCustomMaterialSlotIndex)
|
|
31667
|
+
*/
|
|
31668
|
+
GetFirstCustomMaterialSlotIndex(this: Terrain): number;
|
|
31613
31669
|
/**
|
|
31614
31670
|
* Returns current terrain material color for specified terrain material.
|
|
31615
31671
|
*
|
|
@@ -31620,6 +31676,12 @@ interface Terrain extends BasePart {
|
|
|
31620
31676
|
* @param material
|
|
31621
31677
|
*/
|
|
31622
31678
|
GetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>): Color3;
|
|
31679
|
+
/**
|
|
31680
|
+
* - **ThreadSafety**: Unsafe
|
|
31681
|
+
*
|
|
31682
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialSlot)
|
|
31683
|
+
*/
|
|
31684
|
+
GetMaterialSlot(this: Terrain, slotIndex: number): unknown;
|
|
31623
31685
|
/**
|
|
31624
31686
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31625
31687
|
*
|
|
@@ -31730,6 +31792,12 @@ interface Terrain extends BasePart {
|
|
|
31730
31792
|
* @param targetMaterial The new material.
|
|
31731
31793
|
*/
|
|
31732
31794
|
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>): void;
|
|
31795
|
+
/**
|
|
31796
|
+
* - **ThreadSafety**: Unsafe
|
|
31797
|
+
*
|
|
31798
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ResetMaterialSlot)
|
|
31799
|
+
*/
|
|
31800
|
+
ResetMaterialSlot(this: Terrain, slotIndex: number): void;
|
|
31733
31801
|
/**
|
|
31734
31802
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31735
31803
|
*
|
|
@@ -31779,6 +31847,12 @@ interface Terrain extends BasePart {
|
|
|
31779
31847
|
* @param value
|
|
31780
31848
|
*/
|
|
31781
31849
|
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3): void;
|
|
31850
|
+
/**
|
|
31851
|
+
* - **ThreadSafety**: Unsafe
|
|
31852
|
+
*
|
|
31853
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialSlot)
|
|
31854
|
+
*/
|
|
31855
|
+
SetMaterialSlot(this: Terrain, slotIndex: number, baseMaterial: CastsToEnum<Enum.Material>, materialVariant: string, color: Color3): void;
|
|
31782
31856
|
/**
|
|
31783
31857
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31784
31858
|
*
|
|
@@ -33113,6 +33187,8 @@ interface Tool extends BackpackItem {
|
|
|
33113
33187
|
readonly Unequipped: RBXScriptSignal<() => void>;
|
|
33114
33188
|
}
|
|
33115
33189
|
/**
|
|
33190
|
+
* 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.
|
|
33191
|
+
*
|
|
33116
33192
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel)
|
|
33117
33193
|
*/
|
|
33118
33194
|
interface ProceduralModel extends Model {
|
|
@@ -33125,6 +33201,8 @@ interface ProceduralModel extends Model {
|
|
|
33125
33201
|
*/
|
|
33126
33202
|
readonly _nominal_ProceduralModel: unique symbol;
|
|
33127
33203
|
/**
|
|
33204
|
+
* Stores errors that the generator module might encounter during generation.
|
|
33205
|
+
*
|
|
33128
33206
|
* - **ThreadSafety**: ReadSafe
|
|
33129
33207
|
* - **Tags**: NotReplicated
|
|
33130
33208
|
*
|
|
@@ -33132,12 +33210,16 @@ interface ProceduralModel extends Model {
|
|
|
33132
33210
|
*/
|
|
33133
33211
|
readonly GenerationError: string;
|
|
33134
33212
|
/**
|
|
33213
|
+
* A reference to a `ModuleScript` that contains code which defines how the `ProceduralModel` generates its contents in response to parameter changes.
|
|
33214
|
+
*
|
|
33135
33215
|
* - **ThreadSafety**: ReadSafe
|
|
33136
33216
|
*
|
|
33137
33217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Generator)
|
|
33138
33218
|
*/
|
|
33139
33219
|
Generator: ModuleScript | undefined;
|
|
33140
33220
|
/**
|
|
33221
|
+
* Defines the bounding volume used for generation.
|
|
33222
|
+
*
|
|
33141
33223
|
* - **ThreadSafety**: ReadSafe
|
|
33142
33224
|
*
|
|
33143
33225
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Size)
|
|
@@ -33147,15 +33229,18 @@ interface ProceduralModel extends Model {
|
|
|
33147
33229
|
* - **ThreadSafety**: Unsafe
|
|
33148
33230
|
*
|
|
33149
33231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
|
|
33150
|
-
* @param this
|
|
33232
|
+
* @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.
|
|
33151
33233
|
*/
|
|
33152
33234
|
ForceGeneration(this: ProceduralModel): boolean;
|
|
33153
33235
|
/**
|
|
33236
|
+
* Waits for generation to complete after making parameter changes.
|
|
33237
|
+
*
|
|
33154
33238
|
* - **ThreadSafety**: Unsafe
|
|
33155
33239
|
* - **Tags**: Yields
|
|
33156
33240
|
*
|
|
33157
33241
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#WaitForGenerationAsync)
|
|
33158
|
-
* @param this
|
|
33242
|
+
* @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.
|
|
33243
|
+
* @returns Was the generation successful?
|
|
33159
33244
|
*/
|
|
33160
33245
|
WaitForGenerationAsync(this: ProceduralModel): boolean;
|
|
33161
33246
|
}
|
|
@@ -33519,6 +33604,8 @@ interface Workspace extends WorldRoot {
|
|
|
33519
33604
|
*/
|
|
33520
33605
|
DistributedGameTime: number;
|
|
33521
33606
|
/**
|
|
33607
|
+
* Controls whether parts that fall below `Workspace.FallenPartsDestroyHeight` are automatically destroyed.
|
|
33608
|
+
*
|
|
33522
33609
|
* - **ThreadSafety**: ReadSafe
|
|
33523
33610
|
*
|
|
33524
33611
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#FallHeightEnabled)
|
|
@@ -33549,6 +33636,8 @@ interface Workspace extends WorldRoot {
|
|
|
33549
33636
|
*/
|
|
33550
33637
|
Gravity: number;
|
|
33551
33638
|
/**
|
|
33639
|
+
* The world position at which new objects are placed when inserted from the toolbox.
|
|
33640
|
+
*
|
|
33552
33641
|
* - **ThreadSafety**: ReadSafe
|
|
33553
33642
|
* - **Tags**: NotReplicated
|
|
33554
33643
|
*
|
|
@@ -33567,6 +33656,8 @@ interface Workspace extends WorldRoot {
|
|
|
33567
33656
|
*/
|
|
33568
33657
|
get InterpolationThrottling(): Enum.InterpolationThrottlingMode;
|
|
33569
33658
|
/**
|
|
33659
|
+
* Controls whether animation retargeting is enabled for character animations.
|
|
33660
|
+
*
|
|
33570
33661
|
* - **ThreadSafety**: ReadSafe
|
|
33571
33662
|
*
|
|
33572
33663
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#Retargeting)
|
|
@@ -33740,6 +33831,21 @@ interface PackageUIService extends Instance {
|
|
|
33740
33831
|
*/
|
|
33741
33832
|
readonly _nominal_PackageUIService: unique symbol;
|
|
33742
33833
|
}
|
|
33834
|
+
/**
|
|
33835
|
+
* - **Tags**: NotCreatable, Service
|
|
33836
|
+
*
|
|
33837
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Packages)
|
|
33838
|
+
*/
|
|
33839
|
+
interface Packages extends Instance {
|
|
33840
|
+
/**
|
|
33841
|
+
* **DO NOT USE!**
|
|
33842
|
+
*
|
|
33843
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33844
|
+
* @hidden
|
|
33845
|
+
* @deprecated
|
|
33846
|
+
*/
|
|
33847
|
+
readonly _nominal_Packages: unique symbol;
|
|
33848
|
+
}
|
|
33743
33849
|
/**
|
|
33744
33850
|
* An abstract class for pages objects.
|
|
33745
33851
|
*
|
|
@@ -35661,6 +35767,8 @@ interface Player extends Instance {
|
|
|
35661
35767
|
* - **Tags**: Yields
|
|
35662
35768
|
*
|
|
35663
35769
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsWhoPlayedAsync)
|
|
35770
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
35771
|
+
* @returns An array of user IDs.
|
|
35664
35772
|
*/
|
|
35665
35773
|
GetFriendsWhoPlayedAsync(this: Player): Array<unknown>;
|
|
35666
35774
|
/**
|
|
@@ -36453,7 +36561,7 @@ interface Players extends Instance {
|
|
|
36453
36561
|
*/
|
|
36454
36562
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36455
36563
|
/**
|
|
36456
|
-
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
36564
|
+
* 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.
|
|
36457
36565
|
*
|
|
36458
36566
|
* - **ThreadSafety**: Unsafe
|
|
36459
36567
|
* - **Tags**: Yields
|
|
@@ -36706,6 +36814,8 @@ interface PluginCapabilities extends Instance {
|
|
|
36706
36814
|
readonly _nominal_PluginCapabilities: unique symbol;
|
|
36707
36815
|
}
|
|
36708
36816
|
/**
|
|
36817
|
+
* This service is used by plugins to communicate with other instances of themselves running in other data models.
|
|
36818
|
+
*
|
|
36709
36819
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
36710
36820
|
*
|
|
36711
36821
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService)
|
|
@@ -37713,6 +37823,12 @@ interface RecommendationService extends Instance {
|
|
|
37713
37823
|
* - `DepartureIntent` — The `RecommendationDepartureIntent` indicating the user's intent when leaving a view. For example, `Positive` if the view is considered good.
|
|
37714
37824
|
*/
|
|
37715
37825
|
LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
|
|
37826
|
+
/**
|
|
37827
|
+
* - **ThreadSafety**: Unsafe
|
|
37828
|
+
*
|
|
37829
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
37830
|
+
*/
|
|
37831
|
+
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
37716
37832
|
/**
|
|
37717
37833
|
* - **ThreadSafety**: Unsafe
|
|
37718
37834
|
* - **Tags**: Yields
|
|
@@ -38339,8 +38455,9 @@ interface RunService extends Instance {
|
|
|
38339
38455
|
* @param this Service responsible for all runtime activity and progression of time.
|
|
38340
38456
|
* @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.
|
|
38341
38457
|
* @param frequency Optional `StepFrequency` value indicating the frequency at which to call the bound function. If not provided, the default frequency will be used.
|
|
38458
|
+
* @param priority Optional priority of the binding as an integer; it determines the order in which bound functions are called within a simulation step. Lower numbers are called first. If two bindings have the same priority, the order between them is unspecified. Defaults to 2000.
|
|
38342
38459
|
*/
|
|
38343
|
-
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency
|
|
38460
|
+
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>, priority?: number): RBXScriptConnection;
|
|
38344
38461
|
/**
|
|
38345
38462
|
* Checks the `PredictionStatus` of a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.
|
|
38346
38463
|
*
|
|
@@ -39601,6 +39718,12 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39601
39718
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#Loaded)
|
|
39602
39719
|
*/
|
|
39603
39720
|
readonly Loaded: RBXScriptSignal<() => void>;
|
|
39721
|
+
/**
|
|
39722
|
+
* - **ThreadSafety**: Unsafe
|
|
39723
|
+
*
|
|
39724
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLifecycleChanged)
|
|
39725
|
+
*/
|
|
39726
|
+
readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
|
|
39604
39727
|
/**
|
|
39605
39728
|
* **Deprecated:** This function is deprecated. It is recommended to use `DataModel:BindToClose()` instead.
|
|
39606
39729
|
*
|
|
@@ -42065,6 +42188,8 @@ interface StudioDeviceEmulatorService extends Instance {
|
|
|
42065
42188
|
readonly _nominal_StudioDeviceEmulatorService: unique symbol;
|
|
42066
42189
|
}
|
|
42067
42190
|
/**
|
|
42191
|
+
* Service allowing you to control Studio's Device Simulator.
|
|
42192
|
+
*
|
|
42068
42193
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
42069
42194
|
*
|
|
42070
42195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService)
|
|
@@ -42189,12 +42314,15 @@ interface StudioTestService extends Instance {
|
|
|
42189
42314
|
* - **ThreadSafety**: Unsafe
|
|
42190
42315
|
*
|
|
42191
42316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#AddPlayers)
|
|
42317
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
42318
|
+
* @param numPlayers
|
|
42192
42319
|
*/
|
|
42193
42320
|
AddPlayers(this: StudioTestService, numPlayers: number): void;
|
|
42194
42321
|
/**
|
|
42195
42322
|
* - **ThreadSafety**: Unsafe
|
|
42196
42323
|
*
|
|
42197
42324
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#CanLeaveTest)
|
|
42325
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
42198
42326
|
*/
|
|
42199
42327
|
CanLeaveTest(this: StudioTestService): boolean;
|
|
42200
42328
|
/**
|
|
@@ -42217,6 +42345,7 @@ interface StudioTestService extends Instance {
|
|
|
42217
42345
|
* - **ThreadSafety**: Unsafe
|
|
42218
42346
|
*
|
|
42219
42347
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#LeaveTest)
|
|
42348
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
42220
42349
|
*/
|
|
42221
42350
|
LeaveTest(this: StudioTestService): void;
|
|
42222
42351
|
}
|
|
@@ -42345,6 +42474,16 @@ interface StyleRule extends StyleBase {
|
|
|
42345
42474
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SelectorError)
|
|
42346
42475
|
*/
|
|
42347
42476
|
readonly SelectorError: string;
|
|
42477
|
+
/**
|
|
42478
|
+
* Returns the default transition applied to all properties of the `StyleRule` that don't have an explicit transition set.
|
|
42479
|
+
*
|
|
42480
|
+
* - **ThreadSafety**: Unsafe
|
|
42481
|
+
*
|
|
42482
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetDefaultPropertyTransition)
|
|
42483
|
+
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42484
|
+
* @returns The default transition as a `TweenInfo` or string token, or `nil` if no default transition is set.
|
|
42485
|
+
*/
|
|
42486
|
+
GetDefaultPropertyTransition(this: StyleRule): unknown;
|
|
42348
42487
|
/**
|
|
42349
42488
|
* Returns a dictionary of key-value pairs describing the properties of the `StyleRule`.
|
|
42350
42489
|
*
|
|
@@ -42367,12 +42506,25 @@ interface StyleRule extends StyleBase {
|
|
|
42367
42506
|
*/
|
|
42368
42507
|
GetProperty(this: StyleRule, name: string): unknown;
|
|
42369
42508
|
/**
|
|
42509
|
+
* Returns a dictionary of all property transitions set on the `StyleRule`.
|
|
42510
|
+
*
|
|
42370
42511
|
* - **ThreadSafety**: Unsafe
|
|
42371
42512
|
*
|
|
42372
42513
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetPropertyTransitions)
|
|
42373
42514
|
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42515
|
+
* @returns Dictionary of key-value pairs mapping property names to their transition parameters.
|
|
42374
42516
|
*/
|
|
42375
42517
|
GetPropertyTransitions(this: StyleRule): object;
|
|
42518
|
+
/**
|
|
42519
|
+
* Sets or clears a default transition that applies to all properties of the `StyleRule` that don't have an explicit transition set.
|
|
42520
|
+
*
|
|
42521
|
+
* - **ThreadSafety**: Unsafe
|
|
42522
|
+
*
|
|
42523
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetDefaultPropertyTransition)
|
|
42524
|
+
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42525
|
+
* @param transitionParams Either a `TweenInfo`, a token string defining the default transition timing, or `nil` to remove the default transition.
|
|
42526
|
+
*/
|
|
42527
|
+
SetDefaultPropertyTransition(this: StyleRule, transitionParams: unknown): void;
|
|
42376
42528
|
/**
|
|
42377
42529
|
* Lets you declare and set multiple properties of the `StyleRule` at once.
|
|
42378
42530
|
*
|
|
@@ -42393,17 +42545,24 @@ interface StyleRule extends StyleBase {
|
|
|
42393
42545
|
*/
|
|
42394
42546
|
SetProperty(this: StyleRule, name: string, value: unknown): void;
|
|
42395
42547
|
/**
|
|
42548
|
+
* Sets or clears the transition for a single property on the `StyleRule`.
|
|
42549
|
+
*
|
|
42396
42550
|
* - **ThreadSafety**: Unsafe
|
|
42397
42551
|
*
|
|
42398
42552
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetPropertyTransition)
|
|
42553
|
+
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42554
|
+
* @param property String name of the property to set a transition for, for example `"BackgroundColor3"` or `"Size"`.
|
|
42555
|
+
* @param transitionParams A `TweenInfo` or token string defining the transition timing, or `nil` to remove the transition for this property.
|
|
42399
42556
|
*/
|
|
42400
42557
|
SetPropertyTransition(this: StyleRule, property: string, transitionParams: unknown): void;
|
|
42401
42558
|
/**
|
|
42559
|
+
* Lets you declare and set transitions for multiple properties of the `StyleRule` at once.
|
|
42560
|
+
*
|
|
42402
42561
|
* - **ThreadSafety**: Unsafe
|
|
42403
42562
|
*
|
|
42404
42563
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetPropertyTransitions)
|
|
42405
42564
|
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42406
|
-
* @param properties
|
|
42565
|
+
* @param properties Dictionary of property names to transition parameters.
|
|
42407
42566
|
*/
|
|
42408
42567
|
SetPropertyTransitions(this: StyleRule, properties: object): void;
|
|
42409
42568
|
}
|
|
@@ -45866,7 +46025,7 @@ interface UICorner extends UIComponent {
|
|
|
45866
46025
|
*/
|
|
45867
46026
|
set BottomRightRadius(value: UDim);
|
|
45868
46027
|
/**
|
|
45869
|
-
*
|
|
46028
|
+
* Sets all four corner radii at once and reads from `TopLeftRadius`.
|
|
45870
46029
|
*
|
|
45871
46030
|
* - **ThreadSafety**: ReadSafe
|
|
45872
46031
|
*
|
|
@@ -47325,6 +47484,16 @@ interface UserInputService extends Instance {
|
|
|
47325
47484
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#VREnabled)
|
|
47326
47485
|
*/
|
|
47327
47486
|
readonly VREnabled: boolean;
|
|
47487
|
+
/**
|
|
47488
|
+
* Creates a `VirtualInput` object that a Studio plugin can use to simulate mouse, keyboard, and pointer input.
|
|
47489
|
+
*
|
|
47490
|
+
* - **ThreadSafety**: Unsafe
|
|
47491
|
+
*
|
|
47492
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#CreateVirtualInput)
|
|
47493
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
47494
|
+
* @returns A new `VirtualInput` object, or `nil` if the feature is not available.
|
|
47495
|
+
*/
|
|
47496
|
+
CreateVirtualInput(this: UserInputService): RBXObject;
|
|
47328
47497
|
/**
|
|
47329
47498
|
* Returns whether the given `UserInputType` gamepad supports a button corresponding with the given `KeyCode`.
|
|
47330
47499
|
*
|
|
@@ -49513,6 +49682,8 @@ interface OutputLink extends RBXObject {
|
|
|
49513
49682
|
readonly _nominal_OutputLink: unique symbol;
|
|
49514
49683
|
}
|
|
49515
49684
|
/**
|
|
49685
|
+
* Encapsulates a connection between the current data model and another for plugin communication.
|
|
49686
|
+
*
|
|
49516
49687
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49517
49688
|
*
|
|
49518
49689
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection)
|
|
@@ -49686,6 +49857,8 @@ interface VideoSampler extends RBXObject {
|
|
|
49686
49857
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
49687
49858
|
}
|
|
49688
49859
|
/**
|
|
49860
|
+
* Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49861
|
+
*
|
|
49689
49862
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49690
49863
|
*
|
|
49691
49864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput)
|
|
@@ -49699,6 +49872,72 @@ interface VirtualInput extends RBXObject {
|
|
|
49699
49872
|
* @deprecated
|
|
49700
49873
|
*/
|
|
49701
49874
|
readonly _nominal_VirtualInput: unique symbol;
|
|
49875
|
+
/**
|
|
49876
|
+
* Injects a keyboard key press or release event.
|
|
49877
|
+
*
|
|
49878
|
+
* - **ThreadSafety**: Unsafe
|
|
49879
|
+
*
|
|
49880
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
|
|
49881
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49882
|
+
* @param isPressed Whether to simulate a key press (`true`) or a key release (`false`).
|
|
49883
|
+
* @param keyCode The `KeyCode` of the key to inject.
|
|
49884
|
+
* @param isRepeatedKey Whether this is an auto-repeat event, as occurs when a key is held down. Only valid for text-manipulation keys such as `KeyCode.Backspace`, `KeyCode.Delete`, and the arrow keys. Defaults to `false`.
|
|
49885
|
+
*/
|
|
49886
|
+
SendKey(this: VirtualInput, isPressed: boolean, keyCode: CastsToEnum<Enum.KeyCode>, isRepeatedKey?: boolean): void;
|
|
49887
|
+
/**
|
|
49888
|
+
* Injects a mouse button press or release event at the specified screen position.
|
|
49889
|
+
*
|
|
49890
|
+
* - **ThreadSafety**: Unsafe
|
|
49891
|
+
*
|
|
49892
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
|
|
49893
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49894
|
+
* @param position The screen-space position in pixels at which to inject the event.
|
|
49895
|
+
* @param button The mouse button to use. Supported values are `UserInputType.MouseButton1`, `UserInputType.MouseButton2`, and `UserInputType.MouseButton3`.
|
|
49896
|
+
* @param isDown Whether to simulate a button press (`true`) or a button release (`false`).
|
|
49897
|
+
* @param repeatCount The consecutive-click count for multi-click detection, such as a double- or triple-click. Defaults to `0`.
|
|
49898
|
+
*/
|
|
49899
|
+
SendMouseButton(this: VirtualInput, position: Vector2, button: CastsToEnum<Enum.UserInputType>, isDown: boolean, repeatCount?: number): void;
|
|
49900
|
+
/**
|
|
49901
|
+
* Injects a relative mouse movement event. Only works while the player's cursor is locked.
|
|
49902
|
+
*
|
|
49903
|
+
* - **ThreadSafety**: Unsafe
|
|
49904
|
+
*
|
|
49905
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
|
|
49906
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49907
|
+
* @param positionDelta The relative mouse movement in pixels along each axis.
|
|
49908
|
+
*/
|
|
49909
|
+
SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
|
|
49910
|
+
/**
|
|
49911
|
+
* Moves the virtual mouse cursor to the specified absolute screen position.
|
|
49912
|
+
*
|
|
49913
|
+
* - **ThreadSafety**: Unsafe
|
|
49914
|
+
*
|
|
49915
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
|
|
49916
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49917
|
+
* @param position The target screen-space position in pixels.
|
|
49918
|
+
*/
|
|
49919
|
+
SendMousePosition(this: VirtualInput, position: Vector2): void;
|
|
49920
|
+
/**
|
|
49921
|
+
* Injects a scroll wheel, trackpad pan, or pinch gesture event at the specified screen position.
|
|
49922
|
+
*
|
|
49923
|
+
* - **ThreadSafety**: Unsafe
|
|
49924
|
+
*
|
|
49925
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
|
|
49926
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49927
|
+
* @param position The screen-space position in pixels at which to inject the event.
|
|
49928
|
+
* @param pointerAction A dictionary describing the pointer action to inject. Accepted keys are `Wheel` (number), `Pan` (`Vector2`), and `Pinch` (number). At least one key must have a non-zero value.
|
|
49929
|
+
*/
|
|
49930
|
+
SendPointerAction(this: VirtualInput, position: Vector2, pointerAction: object): void;
|
|
49931
|
+
/**
|
|
49932
|
+
* Injects a text input event as if the specified string was typed on a keyboard.
|
|
49933
|
+
*
|
|
49934
|
+
* - **ThreadSafety**: Unsafe
|
|
49935
|
+
*
|
|
49936
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
|
|
49937
|
+
* @param this Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49938
|
+
* @param text The string to inject as text input.
|
|
49939
|
+
*/
|
|
49940
|
+
SendTextInput(this: VirtualInput, text: string): void;
|
|
49702
49941
|
}
|
|
49703
49942
|
/**
|
|
49704
49943
|
* - **Tags**: NotCreatable, NotReplicated
|