@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;
|
|
@@ -190,7 +191,9 @@ interface Services {
|
|
|
190
191
|
SessionCheckService: SessionCheckService;
|
|
191
192
|
SessionService: SessionService;
|
|
192
193
|
SharedTableRegistry: SharedTableRegistry;
|
|
194
|
+
SlimAnimationReplicationService: SlimAnimationReplicationService;
|
|
193
195
|
SlimContentProvider: SlimContentProvider;
|
|
196
|
+
SlimReplicationService: SlimReplicationService;
|
|
194
197
|
SlimService: SlimService;
|
|
195
198
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
196
199
|
SnippetService: SnippetService;
|
|
@@ -347,6 +350,7 @@ interface CreatableInstances {
|
|
|
347
350
|
Color3Value: Color3Value;
|
|
348
351
|
ColorCorrectionEffect: ColorCorrectionEffect;
|
|
349
352
|
ColorGradingEffect: ColorGradingEffect;
|
|
353
|
+
CompositeValueCurve: CompositeValueCurve;
|
|
350
354
|
CompressorSoundEffect: CompressorSoundEffect;
|
|
351
355
|
ConeHandleAdornment: ConeHandleAdornment;
|
|
352
356
|
Configuration: Configuration;
|
|
@@ -420,6 +424,7 @@ interface CreatableInstances {
|
|
|
420
424
|
LineHandleAdornment: LineHandleAdornment;
|
|
421
425
|
LocalizationTable: LocalizationTable;
|
|
422
426
|
LocalScript: LocalScript;
|
|
427
|
+
MakeupDescription: MakeupDescription;
|
|
423
428
|
ManualGlue: ManualGlue;
|
|
424
429
|
ManualWeld: ManualWeld;
|
|
425
430
|
MarkerCurve: MarkerCurve;
|
|
@@ -725,6 +730,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
725
730
|
ServerReplicator: ServerReplicator;
|
|
726
731
|
ServiceProvider: ServiceProvider;
|
|
727
732
|
SlidingBallConstraint: SlidingBallConstraint;
|
|
733
|
+
SlimAnimationDataEntity: SlimAnimationDataEntity;
|
|
728
734
|
SoundEffect: SoundEffect;
|
|
729
735
|
StackFrame: StackFrame;
|
|
730
736
|
StandardPages: StandardPages;
|
|
@@ -784,7 +790,7 @@ interface Objects extends Instances {
|
|
|
784
790
|
}
|
|
785
791
|
// GENERATED ROBLOX INSTANCE CLASSES
|
|
786
792
|
/**
|
|
787
|
-
* Object is the base class for all classes in the Roblox class hierarchy.
|
|
793
|
+
* `Object` is the base class for all classes in the Roblox class hierarchy.
|
|
788
794
|
*
|
|
789
795
|
* - **Tags**: NotCreatable, NotReplicated
|
|
790
796
|
*
|
|
@@ -1549,6 +1555,21 @@ interface AssetPatchSettings extends Instance {
|
|
|
1549
1555
|
*/
|
|
1550
1556
|
readonly _nominal_AssetPatchSettings: unique symbol;
|
|
1551
1557
|
}
|
|
1558
|
+
/**
|
|
1559
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
1560
|
+
*
|
|
1561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetQualityService)
|
|
1562
|
+
*/
|
|
1563
|
+
interface AssetQualityService extends Instance {
|
|
1564
|
+
/**
|
|
1565
|
+
* **DO NOT USE!**
|
|
1566
|
+
*
|
|
1567
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1568
|
+
* @hidden
|
|
1569
|
+
* @deprecated
|
|
1570
|
+
*/
|
|
1571
|
+
readonly _nominal_AssetQualityService: unique symbol;
|
|
1572
|
+
}
|
|
1552
1573
|
/**
|
|
1553
1574
|
* A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
1554
1575
|
*
|
|
@@ -3383,6 +3404,19 @@ interface CommerceService extends Instance {
|
|
|
3383
3404
|
*/
|
|
3384
3405
|
readonly _nominal_CommerceService: unique symbol;
|
|
3385
3406
|
}
|
|
3407
|
+
/**
|
|
3408
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
|
|
3409
|
+
*/
|
|
3410
|
+
interface CompositeValueCurve extends Instance {
|
|
3411
|
+
/**
|
|
3412
|
+
* **DO NOT USE!**
|
|
3413
|
+
*
|
|
3414
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3415
|
+
* @hidden
|
|
3416
|
+
* @deprecated
|
|
3417
|
+
*/
|
|
3418
|
+
readonly _nominal_CompositeValueCurve: unique symbol;
|
|
3419
|
+
}
|
|
3386
3420
|
/**
|
|
3387
3421
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
3388
3422
|
*
|
|
@@ -6954,8 +6988,6 @@ interface HumanoidDescription extends Instance {
|
|
|
6954
6988
|
readonly _nominal_HumanoidDescription: unique symbol;
|
|
6955
6989
|
}
|
|
6956
6990
|
/**
|
|
6957
|
-
* - **Tags**: NotBrowsable
|
|
6958
|
-
*
|
|
6959
6991
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
|
|
6960
6992
|
*/
|
|
6961
6993
|
interface HumanoidRigDescription extends Instance {
|
|
@@ -8007,6 +8039,21 @@ interface MLService extends Instance {
|
|
|
8007
8039
|
*/
|
|
8008
8040
|
readonly _nominal_MLService: unique symbol;
|
|
8009
8041
|
}
|
|
8042
|
+
/**
|
|
8043
|
+
* - **Tags**: NotBrowsable
|
|
8044
|
+
*
|
|
8045
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
|
|
8046
|
+
*/
|
|
8047
|
+
interface MakeupDescription extends Instance {
|
|
8048
|
+
/**
|
|
8049
|
+
* **DO NOT USE!**
|
|
8050
|
+
*
|
|
8051
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
8052
|
+
* @hidden
|
|
8053
|
+
* @deprecated
|
|
8054
|
+
*/
|
|
8055
|
+
readonly _nominal_MakeupDescription: unique symbol;
|
|
8056
|
+
}
|
|
8010
8057
|
/**
|
|
8011
8058
|
* Represents a list of strings markers in chronological order.
|
|
8012
8059
|
*
|
|
@@ -10384,8 +10431,17 @@ interface Plugin extends Instance {
|
|
|
10384
10431
|
* @param this
|
|
10385
10432
|
* @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
|
|
10386
10433
|
* @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
|
|
10434
|
+
*
|
|
10435
|
+
* @deprecated CreateDockWidgetPluginGuiAsync
|
|
10387
10436
|
*/
|
|
10388
10437
|
CreateDockWidgetPluginGui(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
|
|
10438
|
+
/**
|
|
10439
|
+
* - **ThreadSafety**: Unsafe
|
|
10440
|
+
* - **Tags**: Yields
|
|
10441
|
+
*
|
|
10442
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync)
|
|
10443
|
+
*/
|
|
10444
|
+
CreateDockWidgetPluginGuiAsync(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
|
|
10389
10445
|
/**
|
|
10390
10446
|
* Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
|
|
10391
10447
|
*
|
|
@@ -10396,8 +10452,17 @@ interface Plugin extends Instance {
|
|
|
10396
10452
|
* @param this
|
|
10397
10453
|
* @param rigModel
|
|
10398
10454
|
* @param isR15
|
|
10455
|
+
*
|
|
10456
|
+
* @deprecated ImportFbxAnimationAsync
|
|
10399
10457
|
*/
|
|
10400
10458
|
ImportFbxAnimation(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
|
|
10459
|
+
/**
|
|
10460
|
+
* - **ThreadSafety**: Unsafe
|
|
10461
|
+
* - **Tags**: Yields
|
|
10462
|
+
*
|
|
10463
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync)
|
|
10464
|
+
*/
|
|
10465
|
+
ImportFbxAnimationAsync(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
|
|
10401
10466
|
/**
|
|
10402
10467
|
* Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
|
|
10403
10468
|
*
|
|
@@ -10407,8 +10472,17 @@ interface Plugin extends Instance {
|
|
|
10407
10472
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRig)
|
|
10408
10473
|
* @param this
|
|
10409
10474
|
* @param isR15
|
|
10475
|
+
*
|
|
10476
|
+
* @deprecated ImportFbxRigAsync
|
|
10410
10477
|
*/
|
|
10411
10478
|
ImportFbxRig(this: Plugin, isR15?: boolean): Model;
|
|
10479
|
+
/**
|
|
10480
|
+
* - **ThreadSafety**: Unsafe
|
|
10481
|
+
* - **Tags**: Yields
|
|
10482
|
+
*
|
|
10483
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync)
|
|
10484
|
+
*/
|
|
10485
|
+
ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
|
|
10412
10486
|
/**
|
|
10413
10487
|
* Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
|
|
10414
10488
|
*
|
|
@@ -10420,6 +10494,13 @@ interface Plugin extends Instance {
|
|
|
10420
10494
|
* @param assetType
|
|
10421
10495
|
*/
|
|
10422
10496
|
PromptForExistingAssetId(this: Plugin, assetType: string): number;
|
|
10497
|
+
/**
|
|
10498
|
+
* - **ThreadSafety**: Unsafe
|
|
10499
|
+
* - **Tags**: Yields
|
|
10500
|
+
*
|
|
10501
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync)
|
|
10502
|
+
*/
|
|
10503
|
+
PromptForExistingAssetIdAsync(this: Plugin, assetType: string): number;
|
|
10423
10504
|
/**
|
|
10424
10505
|
* Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
|
|
10425
10506
|
*
|
|
@@ -10429,8 +10510,17 @@ interface Plugin extends Instance {
|
|
|
10429
10510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelection)
|
|
10430
10511
|
* @param this
|
|
10431
10512
|
* @param suggestedFileName
|
|
10513
|
+
*
|
|
10514
|
+
* @deprecated PromptSaveSelectionAsync
|
|
10432
10515
|
*/
|
|
10433
10516
|
PromptSaveSelection(this: Plugin, suggestedFileName?: string): boolean;
|
|
10517
|
+
/**
|
|
10518
|
+
* - **ThreadSafety**: Unsafe
|
|
10519
|
+
* - **Tags**: Yields
|
|
10520
|
+
*
|
|
10521
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync)
|
|
10522
|
+
*/
|
|
10523
|
+
PromptSaveSelectionAsync(this: Plugin, suggestedFileName?: string): boolean;
|
|
10434
10524
|
/**
|
|
10435
10525
|
* Fired when the plugin is deactivated.
|
|
10436
10526
|
*
|
|
@@ -12378,6 +12468,51 @@ interface Sky extends Instance {
|
|
|
12378
12468
|
*/
|
|
12379
12469
|
readonly _nominal_Sky: unique symbol;
|
|
12380
12470
|
}
|
|
12471
|
+
/**
|
|
12472
|
+
* - **Tags**: NotCreatable
|
|
12473
|
+
*
|
|
12474
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationDataEntity)
|
|
12475
|
+
*/
|
|
12476
|
+
interface SlimAnimationDataEntity extends Instance {
|
|
12477
|
+
/**
|
|
12478
|
+
* **DO NOT USE!**
|
|
12479
|
+
*
|
|
12480
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12481
|
+
* @hidden
|
|
12482
|
+
* @deprecated
|
|
12483
|
+
*/
|
|
12484
|
+
readonly _nominal_SlimAnimationDataEntity: unique symbol;
|
|
12485
|
+
}
|
|
12486
|
+
/**
|
|
12487
|
+
* - **Tags**: NotCreatable, Service
|
|
12488
|
+
*
|
|
12489
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationReplicationService)
|
|
12490
|
+
*/
|
|
12491
|
+
interface SlimAnimationReplicationService extends Instance {
|
|
12492
|
+
/**
|
|
12493
|
+
* **DO NOT USE!**
|
|
12494
|
+
*
|
|
12495
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12496
|
+
* @hidden
|
|
12497
|
+
* @deprecated
|
|
12498
|
+
*/
|
|
12499
|
+
readonly _nominal_SlimAnimationReplicationService: unique symbol;
|
|
12500
|
+
}
|
|
12501
|
+
/**
|
|
12502
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12503
|
+
*
|
|
12504
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimReplicationService)
|
|
12505
|
+
*/
|
|
12506
|
+
interface SlimReplicationService extends Instance {
|
|
12507
|
+
/**
|
|
12508
|
+
* **DO NOT USE!**
|
|
12509
|
+
*
|
|
12510
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12511
|
+
* @hidden
|
|
12512
|
+
* @deprecated
|
|
12513
|
+
*/
|
|
12514
|
+
readonly _nominal_SlimReplicationService: unique symbol;
|
|
12515
|
+
}
|
|
12381
12516
|
/**
|
|
12382
12517
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12383
12518
|
*
|
|
@@ -13282,8 +13417,17 @@ interface StudioService extends Instance {
|
|
|
13282
13417
|
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13283
13418
|
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13284
13419
|
* @returns The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).
|
|
13420
|
+
*
|
|
13421
|
+
* @deprecated PromptImportFileAsync
|
|
13285
13422
|
*/
|
|
13286
13423
|
PromptImportFile(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
|
|
13424
|
+
/**
|
|
13425
|
+
* - **ThreadSafety**: Unsafe
|
|
13426
|
+
* - **Tags**: Yields
|
|
13427
|
+
*
|
|
13428
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFileAsync)
|
|
13429
|
+
*/
|
|
13430
|
+
PromptImportFileAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
|
|
13287
13431
|
/**
|
|
13288
13432
|
* Prompts the current Studio user to select files to add as `Files`.
|
|
13289
13433
|
*
|
|
@@ -13294,8 +13438,17 @@ interface StudioService extends Instance {
|
|
|
13294
13438
|
* @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
|
|
13295
13439
|
* @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
|
|
13296
13440
|
* @returns The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).
|
|
13441
|
+
*
|
|
13442
|
+
* @deprecated PromptImportFilesAsync
|
|
13297
13443
|
*/
|
|
13298
13444
|
PromptImportFiles(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
|
|
13445
|
+
/**
|
|
13446
|
+
* - **ThreadSafety**: Unsafe
|
|
13447
|
+
* - **Tags**: Yields
|
|
13448
|
+
*
|
|
13449
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFilesAsync)
|
|
13450
|
+
*/
|
|
13451
|
+
PromptImportFilesAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
|
|
13299
13452
|
}
|
|
13300
13453
|
/**
|
|
13301
13454
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -13914,8 +14067,17 @@ interface TestService extends Instance {
|
|
|
13914
14067
|
*
|
|
13915
14068
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Run)
|
|
13916
14069
|
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
14070
|
+
*
|
|
14071
|
+
* @deprecated RunAsync
|
|
13917
14072
|
*/
|
|
13918
14073
|
Run(this: TestService): void;
|
|
14074
|
+
/**
|
|
14075
|
+
* - **ThreadSafety**: Unsafe
|
|
14076
|
+
* - **Tags**: Yields
|
|
14077
|
+
*
|
|
14078
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RunAsync)
|
|
14079
|
+
*/
|
|
14080
|
+
RunAsync(this: TestService): void;
|
|
13919
14081
|
}
|
|
13920
14082
|
/**
|
|
13921
14083
|
* - **Tags**: NotCreatable, Service
|
|
@@ -14889,7 +15051,7 @@ interface VRStatusService extends Instance {
|
|
|
14889
15051
|
readonly _nominal_VRStatusService: unique symbol;
|
|
14890
15052
|
}
|
|
14891
15053
|
/**
|
|
14892
|
-
* Base class of all
|
|
15054
|
+
* Base class of all "value instance" objects.
|
|
14893
15055
|
*
|
|
14894
15056
|
* - **Tags**: NotCreatable
|
|
14895
15057
|
*
|