@rbxts/types 1.0.861 → 1.0.862
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.
|
@@ -37,7 +37,6 @@ interface Services {
|
|
|
37
37
|
CloudCRUDService: CloudCRUDService;
|
|
38
38
|
CollaboratorsService: CollaboratorsService;
|
|
39
39
|
CollectionService: CollectionService;
|
|
40
|
-
CommandService: CommandService;
|
|
41
40
|
CommerceService: CommerceService;
|
|
42
41
|
ConfigService: ConfigService;
|
|
43
42
|
ConfigureServerService: ConfigureServerService;
|
|
@@ -558,7 +557,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
558
557
|
Clothing: Clothing;
|
|
559
558
|
CloudLocalizationTable: CloudLocalizationTable;
|
|
560
559
|
Collaborator: Collaborator;
|
|
561
|
-
CommandInstance: CommandInstance;
|
|
562
560
|
Constraint: Constraint;
|
|
563
561
|
Controller: Controller;
|
|
564
562
|
ControllerBase: ControllerBase;
|
|
@@ -6606,6 +6604,12 @@ interface AuroraScriptObject extends Instance {
|
|
|
6606
6604
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptObject#LODLevel)
|
|
6607
6605
|
*/
|
|
6608
6606
|
LODLevel: number;
|
|
6607
|
+
/**
|
|
6608
|
+
* - **ThreadSafety**: ReadSafe
|
|
6609
|
+
*
|
|
6610
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptObject#PriorFrameInvoked)
|
|
6611
|
+
*/
|
|
6612
|
+
PriorFrameInvoked: number;
|
|
6609
6613
|
}
|
|
6610
6614
|
/**
|
|
6611
6615
|
* - **Tags**: NotCreatable, Service
|
|
@@ -6700,6 +6704,12 @@ interface AuroraService extends Instance {
|
|
|
6700
6704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsPredicted)
|
|
6701
6705
|
*/
|
|
6702
6706
|
IsPredicted(this: AuroraService, target: Instance): boolean;
|
|
6707
|
+
/**
|
|
6708
|
+
* - **ThreadSafety**: Unsafe
|
|
6709
|
+
*
|
|
6710
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
6711
|
+
*/
|
|
6712
|
+
PlayInputRecording(this: AuroraService): void;
|
|
6703
6713
|
/**
|
|
6704
6714
|
* - **ThreadSafety**: Unsafe
|
|
6705
6715
|
*
|
|
@@ -6718,6 +6728,12 @@ interface AuroraService extends Instance {
|
|
|
6718
6728
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
6719
6729
|
*/
|
|
6720
6730
|
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
6731
|
+
/**
|
|
6732
|
+
* - **ThreadSafety**: Unsafe
|
|
6733
|
+
*
|
|
6734
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
6735
|
+
*/
|
|
6736
|
+
StartInputRecording(this: AuroraService): void;
|
|
6721
6737
|
/**
|
|
6722
6738
|
* - **ThreadSafety**: Unsafe
|
|
6723
6739
|
*
|
|
@@ -6730,6 +6746,12 @@ interface AuroraService extends Instance {
|
|
|
6730
6746
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
6731
6747
|
*/
|
|
6732
6748
|
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
6749
|
+
/**
|
|
6750
|
+
* - **ThreadSafety**: Unsafe
|
|
6751
|
+
*
|
|
6752
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
6753
|
+
*/
|
|
6754
|
+
StopInputRecording(this: AuroraService): void;
|
|
6733
6755
|
/**
|
|
6734
6756
|
* - **ThreadSafety**: Unsafe
|
|
6735
6757
|
*
|
|
@@ -7172,7 +7194,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7172
7194
|
*
|
|
7173
7195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavorite)
|
|
7174
7196
|
* @param this A service to support developer Avatar Editors.
|
|
7175
|
-
* @param itemId The
|
|
7197
|
+
* @param itemId The ID of the specified asset or bundle.
|
|
7176
7198
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
7177
7199
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
7178
7200
|
*/
|
|
@@ -7233,7 +7255,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7233
7255
|
*/
|
|
7234
7256
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
7235
7257
|
/**
|
|
7236
|
-
* Returns a list of recommended assets based on a given `AssetType` and asset
|
|
7258
|
+
* Returns a list of recommended assets based on a given `AssetType` and asset ID.
|
|
7237
7259
|
*
|
|
7238
7260
|
* - **ThreadSafety**: Unsafe
|
|
7239
7261
|
* - **Tags**: Yields
|
|
@@ -7241,7 +7263,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7241
7263
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssets)
|
|
7242
7264
|
* @param this A service to support developer Avatar Editors.
|
|
7243
7265
|
* @param assetType The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
|
|
7244
|
-
* @param contextAssetId The
|
|
7266
|
+
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
7245
7267
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
7246
7268
|
*/
|
|
7247
7269
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
@@ -10656,57 +10678,6 @@ interface CollectionService extends Instance {
|
|
|
10656
10678
|
*/
|
|
10657
10679
|
readonly TagRemoved: RBXScriptSignal<(tag: string) => void>;
|
|
10658
10680
|
}
|
|
10659
|
-
/**
|
|
10660
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
10661
|
-
*
|
|
10662
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance)
|
|
10663
|
-
*/
|
|
10664
|
-
interface CommandInstance extends Instance {
|
|
10665
|
-
/**
|
|
10666
|
-
* **DO NOT USE!**
|
|
10667
|
-
*
|
|
10668
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10669
|
-
* @hidden
|
|
10670
|
-
* @deprecated
|
|
10671
|
-
*/
|
|
10672
|
-
readonly _nominal_CommandInstance: unique symbol;
|
|
10673
|
-
/**
|
|
10674
|
-
* - **ThreadSafety**: ReadSafe
|
|
10675
|
-
* - **Tags**: NotReplicated
|
|
10676
|
-
*
|
|
10677
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#AllowGUIAccessPoints)
|
|
10678
|
-
*/
|
|
10679
|
-
readonly AllowGUIAccessPoints: boolean;
|
|
10680
|
-
/**
|
|
10681
|
-
* - **ThreadSafety**: ReadSafe
|
|
10682
|
-
* - **Tags**: NotReplicated
|
|
10683
|
-
*
|
|
10684
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#DisplayName)
|
|
10685
|
-
*/
|
|
10686
|
-
DisplayName: string;
|
|
10687
|
-
/**
|
|
10688
|
-
* - **ThreadSafety**: ReadSafe
|
|
10689
|
-
* - **Tags**: NotReplicated
|
|
10690
|
-
*
|
|
10691
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance#Name)
|
|
10692
|
-
*/
|
|
10693
|
-
readonly Name: string;
|
|
10694
|
-
}
|
|
10695
|
-
/**
|
|
10696
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
10697
|
-
*
|
|
10698
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandService)
|
|
10699
|
-
*/
|
|
10700
|
-
interface CommandService extends Instance {
|
|
10701
|
-
/**
|
|
10702
|
-
* **DO NOT USE!**
|
|
10703
|
-
*
|
|
10704
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
10705
|
-
* @hidden
|
|
10706
|
-
* @deprecated
|
|
10707
|
-
*/
|
|
10708
|
-
readonly _nominal_CommandService: unique symbol;
|
|
10709
|
-
}
|
|
10710
10681
|
/**
|
|
10711
10682
|
* Supports real-world purchases that you can bundle with digital benefits.
|
|
10712
10683
|
*
|
|
@@ -18380,6 +18351,13 @@ interface VideoFrame extends GuiObject {
|
|
|
18380
18351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Video)
|
|
18381
18352
|
*/
|
|
18382
18353
|
Video: ContentId;
|
|
18354
|
+
/**
|
|
18355
|
+
* - **ThreadSafety**: ReadSafe
|
|
18356
|
+
* - **Tags**: Hidden
|
|
18357
|
+
*
|
|
18358
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#VideoContent)
|
|
18359
|
+
*/
|
|
18360
|
+
VideoContent: Content;
|
|
18383
18361
|
/**
|
|
18384
18362
|
* Indicates how loud the `VideoFrame.Video` is currently playing back.
|
|
18385
18363
|
*
|
|
@@ -23402,8 +23380,6 @@ interface IncrementalPatchBuilder extends Instance {
|
|
|
23402
23380
|
/**
|
|
23403
23381
|
* Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
23404
23382
|
*
|
|
23405
|
-
* - **Tags**: NotBrowsable
|
|
23406
|
-
*
|
|
23407
23383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction)
|
|
23408
23384
|
*/
|
|
23409
23385
|
interface InputAction extends Instance {
|
|
@@ -23479,8 +23455,6 @@ interface InputAction extends Instance {
|
|
|
23479
23455
|
/**
|
|
23480
23456
|
* Defines which hardware binding should trigger the parent `InputAction`.
|
|
23481
23457
|
*
|
|
23482
|
-
* - **Tags**: NotBrowsable
|
|
23483
|
-
*
|
|
23484
23458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding)
|
|
23485
23459
|
*/
|
|
23486
23460
|
interface InputBinding extends Instance {
|
|
@@ -23592,8 +23566,6 @@ interface InputBinding extends Instance {
|
|
|
23592
23566
|
/**
|
|
23593
23567
|
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
23594
23568
|
*
|
|
23595
|
-
* - **Tags**: NotBrowsable
|
|
23596
|
-
*
|
|
23597
23569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext)
|
|
23598
23570
|
*/
|
|
23599
23571
|
interface InputContext extends Instance {
|
|
@@ -25123,7 +25095,7 @@ interface LocalizationService extends Instance {
|
|
|
25123
25095
|
*/
|
|
25124
25096
|
readonly RobloxLocaleId: string;
|
|
25125
25097
|
/**
|
|
25126
|
-
* The locale
|
|
25098
|
+
* The locale ID that the local player has set for their operating system.
|
|
25127
25099
|
*
|
|
25128
25100
|
* - **ThreadSafety**: ReadSafe
|
|
25129
25101
|
* - **Tags**: NotReplicated
|
|
@@ -28125,10 +28097,13 @@ interface BasePart extends PVInstance {
|
|
|
28125
28097
|
* Returns the base part of an assembly of parts.
|
|
28126
28098
|
*
|
|
28127
28099
|
* - **ThreadSafety**: Safe
|
|
28100
|
+
* - **Tags**:
|
|
28128
28101
|
*
|
|
28129
28102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetRootPart)
|
|
28130
28103
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
28131
28104
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
28105
|
+
*
|
|
28106
|
+
* @deprecated AssemblyRootPart
|
|
28132
28107
|
*/
|
|
28133
28108
|
GetRootPart(this: BasePart): BasePart;
|
|
28134
28109
|
/**
|
|
@@ -30913,7 +30888,7 @@ interface PackageLink extends Instance {
|
|
|
30913
30888
|
*/
|
|
30914
30889
|
get DefaultName(): string;
|
|
30915
30890
|
/**
|
|
30916
|
-
* The
|
|
30891
|
+
* The ID of the asset this package corresponds to.
|
|
30917
30892
|
*
|
|
30918
30893
|
* - **ThreadSafety**: ReadSafe
|
|
30919
30894
|
* - **Tags**: NotReplicated
|
|
@@ -33550,7 +33525,7 @@ interface Players extends Instance {
|
|
|
33550
33525
|
*
|
|
33551
33526
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitId)
|
|
33552
33527
|
* @param this A service that contains presently connected `Player` objects.
|
|
33553
|
-
* @param outfitId The
|
|
33528
|
+
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
33554
33529
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
33555
33530
|
*/
|
|
33556
33531
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
@@ -38,7 +38,6 @@ interface Services {
|
|
|
38
38
|
CloudCRUDService: CloudCRUDService;
|
|
39
39
|
CollaboratorsService: CollaboratorsService;
|
|
40
40
|
CollectionService: CollectionService;
|
|
41
|
-
CommandService: CommandService;
|
|
42
41
|
CommerceService: CommerceService;
|
|
43
42
|
ConfigService: ConfigService;
|
|
44
43
|
ConfigureServerService: ConfigureServerService;
|
|
@@ -579,7 +578,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
579
578
|
Clothing: Clothing;
|
|
580
579
|
CloudLocalizationTable: CloudLocalizationTable;
|
|
581
580
|
Collaborator: Collaborator;
|
|
582
|
-
CommandInstance: CommandInstance;
|
|
583
581
|
Constraint: Constraint;
|
|
584
582
|
Controller: Controller;
|
|
585
583
|
ControllerBase: ControllerBase;
|
|
@@ -3221,36 +3219,6 @@ interface CollectionService extends Instance {
|
|
|
3221
3219
|
*/
|
|
3222
3220
|
readonly _nominal_CollectionService: unique symbol;
|
|
3223
3221
|
}
|
|
3224
|
-
/**
|
|
3225
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
3226
|
-
*
|
|
3227
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance)
|
|
3228
|
-
*/
|
|
3229
|
-
interface CommandInstance extends Instance {
|
|
3230
|
-
/**
|
|
3231
|
-
* **DO NOT USE!**
|
|
3232
|
-
*
|
|
3233
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3234
|
-
* @hidden
|
|
3235
|
-
* @deprecated
|
|
3236
|
-
*/
|
|
3237
|
-
readonly _nominal_CommandInstance: unique symbol;
|
|
3238
|
-
}
|
|
3239
|
-
/**
|
|
3240
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
3241
|
-
*
|
|
3242
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandService)
|
|
3243
|
-
*/
|
|
3244
|
-
interface CommandService extends Instance {
|
|
3245
|
-
/**
|
|
3246
|
-
* **DO NOT USE!**
|
|
3247
|
-
*
|
|
3248
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3249
|
-
* @hidden
|
|
3250
|
-
* @deprecated
|
|
3251
|
-
*/
|
|
3252
|
-
readonly _nominal_CommandService: unique symbol;
|
|
3253
|
-
}
|
|
3254
3222
|
/**
|
|
3255
3223
|
* Supports real-world purchases that you can bundle with digital benefits.
|
|
3256
3224
|
*
|
|
@@ -5419,7 +5387,7 @@ interface File extends Instance {
|
|
|
5419
5387
|
*
|
|
5420
5388
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/File#GetTemporaryId)
|
|
5421
5389
|
* @param this An asset loaded from a file on disk.
|
|
5422
|
-
* @returns The temporary asset
|
|
5390
|
+
* @returns The temporary asset ID.
|
|
5423
5391
|
*/
|
|
5424
5392
|
GetTemporaryId(this: File): ContentId;
|
|
5425
5393
|
}
|
|
@@ -6875,8 +6843,6 @@ interface IncrementalPatchBuilder extends Instance {
|
|
|
6875
6843
|
/**
|
|
6876
6844
|
* Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
6877
6845
|
*
|
|
6878
|
-
* - **Tags**: NotBrowsable
|
|
6879
|
-
*
|
|
6880
6846
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction)
|
|
6881
6847
|
*/
|
|
6882
6848
|
interface InputAction extends Instance {
|
|
@@ -6892,8 +6858,6 @@ interface InputAction extends Instance {
|
|
|
6892
6858
|
/**
|
|
6893
6859
|
* Defines which hardware binding should trigger the parent `InputAction`.
|
|
6894
6860
|
*
|
|
6895
|
-
* - **Tags**: NotBrowsable
|
|
6896
|
-
*
|
|
6897
6861
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding)
|
|
6898
6862
|
*/
|
|
6899
6863
|
interface InputBinding extends Instance {
|
|
@@ -6909,8 +6873,6 @@ interface InputBinding extends Instance {
|
|
|
6909
6873
|
/**
|
|
6910
6874
|
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
6911
6875
|
*
|
|
6912
|
-
* - **Tags**: NotBrowsable
|
|
6913
|
-
*
|
|
6914
6876
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext)
|
|
6915
6877
|
*/
|
|
6916
6878
|
interface InputContext extends Instance {
|
|
@@ -20423,7 +20423,7 @@ declare namespace Enum {
|
|
|
20423
20423
|
}
|
|
20424
20424
|
export const Cylinder: Cylinder;
|
|
20425
20425
|
/**
|
|
20426
|
-
* The mesh is determined by the Roblox mesh asset
|
|
20426
|
+
* The mesh is determined by the Roblox mesh asset ID provided.
|
|
20427
20427
|
*
|
|
20428
20428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MeshType#FileMesh)
|
|
20429
20429
|
*/
|
|
@@ -20844,7 +20844,7 @@ declare namespace Enum {
|
|
|
20844
20844
|
}
|
|
20845
20845
|
export const Default: Default;
|
|
20846
20846
|
/**
|
|
20847
|
-
* The mouse is locked
|
|
20847
|
+
* The mouse is locked and cannot move from the center of the user's screen.
|
|
20848
20848
|
*
|
|
20849
20849
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCenter)
|
|
20850
20850
|
*/
|
|
@@ -20855,7 +20855,7 @@ declare namespace Enum {
|
|
|
20855
20855
|
}
|
|
20856
20856
|
export const LockCenter: LockCenter;
|
|
20857
20857
|
/**
|
|
20858
|
-
* The mouse is locked
|
|
20858
|
+
* The mouse is locked and cannot move from its current position on the user's screen at the time of locking.
|
|
20859
20859
|
*
|
|
20860
20860
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCurrentPosition)
|
|
20861
20861
|
*/
|