@rbxts/types 1.0.860 → 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.
@@ -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;
@@ -125,6 +124,7 @@ interface Services {
125
124
  OpenCloudService: OpenCloudService;
126
125
  PackageService: PackageService;
127
126
  PackageUIService: PackageUIService;
127
+ PartyEmulatorService: PartyEmulatorService;
128
128
  PatchBundlerFileWatch: PatchBundlerFileWatch;
129
129
  PathfindingService: PathfindingService;
130
130
  PerformanceControlService: PerformanceControlService;
@@ -276,6 +276,7 @@ interface CreatableInstances {
276
276
  AudioFader: AudioFader;
277
277
  AudioFilter: AudioFilter;
278
278
  AudioFlanger: AudioFlanger;
279
+ AudioGate: AudioGate;
279
280
  AudioLimiter: AudioLimiter;
280
281
  AudioListener: AudioListener;
281
282
  AudioPitchShifter: AudioPitchShifter;
@@ -577,7 +578,6 @@ interface Instances extends Services, CreatableInstances {
577
578
  Clothing: Clothing;
578
579
  CloudLocalizationTable: CloudLocalizationTable;
579
580
  Collaborator: Collaborator;
580
- CommandInstance: CommandInstance;
581
581
  Constraint: Constraint;
582
582
  Controller: Controller;
583
583
  ControllerBase: ControllerBase;
@@ -1719,6 +1719,21 @@ interface AudioFocusService extends Instance {
1719
1719
  */
1720
1720
  readonly _nominal_AudioFocusService: unique symbol;
1721
1721
  }
1722
+ /**
1723
+ * - **Tags**: NotBrowsable
1724
+ *
1725
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
1726
+ */
1727
+ interface AudioGate extends Instance {
1728
+ /**
1729
+ * **DO NOT USE!**
1730
+ *
1731
+ * This field exists to force TypeScript to recognize this as a nominal type
1732
+ * @hidden
1733
+ * @deprecated
1734
+ */
1735
+ readonly _nominal_AudioGate: unique symbol;
1736
+ }
1722
1737
  /**
1723
1738
  * Limits how loud audio streams are allowed to be.
1724
1739
  *
@@ -1846,8 +1861,6 @@ interface AudioSpeechToText extends Instance {
1846
1861
  /**
1847
1862
  * Plays text as speech audio.
1848
1863
  *
1849
- * - **Tags**: NotBrowsable
1850
- *
1851
1864
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
1852
1865
  */
1853
1866
  interface AudioTextToSpeech extends Instance {
@@ -3206,36 +3219,6 @@ interface CollectionService extends Instance {
3206
3219
  */
3207
3220
  readonly _nominal_CollectionService: unique symbol;
3208
3221
  }
3209
- /**
3210
- * - **Tags**: NotCreatable, NotReplicated
3211
- *
3212
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandInstance)
3213
- */
3214
- interface CommandInstance extends Instance {
3215
- /**
3216
- * **DO NOT USE!**
3217
- *
3218
- * This field exists to force TypeScript to recognize this as a nominal type
3219
- * @hidden
3220
- * @deprecated
3221
- */
3222
- readonly _nominal_CommandInstance: unique symbol;
3223
- }
3224
- /**
3225
- * - **Tags**: NotCreatable, Service, NotReplicated
3226
- *
3227
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommandService)
3228
- */
3229
- interface CommandService 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_CommandService: unique symbol;
3238
- }
3239
3222
  /**
3240
3223
  * Supports real-world purchases that you can bundle with digital benefits.
3241
3224
  *
@@ -5404,7 +5387,7 @@ interface File extends Instance {
5404
5387
  *
5405
5388
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/File#GetTemporaryId)
5406
5389
  * @param this An asset loaded from a file on disk.
5407
- * @returns The temporary asset id.
5390
+ * @returns The temporary asset ID.
5408
5391
  */
5409
5392
  GetTemporaryId(this: File): ContentId;
5410
5393
  }
@@ -6860,8 +6843,6 @@ interface IncrementalPatchBuilder extends Instance {
6860
6843
  /**
6861
6844
  * Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
6862
6845
  *
6863
- * - **Tags**: NotBrowsable
6864
- *
6865
6846
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction)
6866
6847
  */
6867
6848
  interface InputAction extends Instance {
@@ -6877,8 +6858,6 @@ interface InputAction extends Instance {
6877
6858
  /**
6878
6859
  * Defines which hardware binding should trigger the parent `InputAction`.
6879
6860
  *
6880
- * - **Tags**: NotBrowsable
6881
- *
6882
6861
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding)
6883
6862
  */
6884
6863
  interface InputBinding extends Instance {
@@ -6894,8 +6873,6 @@ interface InputBinding extends Instance {
6894
6873
  /**
6895
6874
  * Collection of actions which holds related actions and defines how they interact with other contexts/actions.
6896
6875
  *
6897
- * - **Tags**: NotBrowsable
6898
- *
6899
6876
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputContext)
6900
6877
  */
6901
6878
  interface InputContext extends Instance {
@@ -9395,6 +9372,21 @@ interface ParticleEmitter extends Instance {
9395
9372
  */
9396
9373
  readonly _nominal_ParticleEmitter: unique symbol;
9397
9374
  }
9375
+ /**
9376
+ * - **Tags**: NotCreatable, Service, NotReplicated
9377
+ *
9378
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
9379
+ */
9380
+ interface PartyEmulatorService extends Instance {
9381
+ /**
9382
+ * **DO NOT USE!**
9383
+ *
9384
+ * This field exists to force TypeScript to recognize this as a nominal type
9385
+ * @hidden
9386
+ * @deprecated
9387
+ */
9388
+ readonly _nominal_PartyEmulatorService: unique symbol;
9389
+ }
9398
9390
  /**
9399
9391
  * - **Tags**: NotCreatable, Service, NotReplicated
9400
9392
  *
@@ -9655,7 +9647,7 @@ interface PlatformFriendsService extends Instance {
9655
9647
  readonly _nominal_PlatformFriendsService: unique symbol;
9656
9648
  }
9657
9649
  /**
9658
- * An object that represents a presently connected client to the game.
9650
+ * An object that represents a presently connected client to the experience.
9659
9651
  *
9660
9652
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
9661
9653
  */
@@ -9669,12 +9661,12 @@ interface Player extends Instance {
9669
9661
  */
9670
9662
  readonly _nominal_Player: unique symbol;
9671
9663
  /**
9672
- * Sets the AccountAge of the player.
9664
+ * Sets the `AccountAge` of the player.
9673
9665
  *
9674
9666
  * - **ThreadSafety**: Unsafe
9675
9667
  *
9676
9668
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetAccountAge)
9677
- * @param this An object that represents a presently connected client to the game.
9669
+ * @param this An object that represents a presently connected client to the experience.
9678
9670
  * @param accountAge The age of the account in days.
9679
9671
  */
9680
9672
  SetAccountAge(this: Player, accountAge: number): void;
@@ -9684,7 +9676,7 @@ interface Player extends Instance {
9684
9676
  * - **ThreadSafety**: Unsafe
9685
9677
  *
9686
9678
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetSuperSafeChat)
9687
- * @param this An object that represents a presently connected client to the game.
9679
+ * @param this An object that represents a presently connected client to the experience.
9688
9680
  * @param value A boolean indicating whether or not the player sees filtered chat.
9689
9681
  */
9690
9682
  SetSuperSafeChat(this: Player, value: boolean): void;
@@ -11497,6 +11489,7 @@ interface ScriptEditorService extends Instance {
11497
11489
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync)
11498
11490
  * @param this This service is used for interacting with `ScriptDocument` instances.
11499
11491
  * @param script
11492
+ * @param options
11500
11493
  */
11501
11494
  OpenScriptDocumentAsync(this: ScriptEditorService, script: LuaSourceContainer, options?: object): unknown;
11502
11495
  /**
@@ -9943,6 +9943,42 @@ declare namespace Enum {
9943
9943
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogTone | undefined;
9944
9944
  }
9945
9945
  export type DialogTone = DialogTone.Neutral | DialogTone.Friendly | DialogTone.Enemy;
9946
+ /**
9947
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize)
9948
+ */
9949
+ export namespace DisplaySize {
9950
+ /**
9951
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small)
9952
+ */
9953
+ export interface Small extends globalThis.EnumItem {
9954
+ Name: "Small";
9955
+ Value: 0;
9956
+ EnumType: typeof globalThis.Enum.DisplaySize;
9957
+ }
9958
+ export const Small: Small;
9959
+ /**
9960
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium)
9961
+ */
9962
+ export interface Medium extends globalThis.EnumItem {
9963
+ Name: "Medium";
9964
+ Value: 1;
9965
+ EnumType: typeof globalThis.Enum.DisplaySize;
9966
+ }
9967
+ export const Medium: Medium;
9968
+ /**
9969
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large)
9970
+ */
9971
+ export interface Large extends globalThis.EnumItem {
9972
+ Name: "Large";
9973
+ Value: 2;
9974
+ EnumType: typeof globalThis.Enum.DisplaySize;
9975
+ }
9976
+ export const Large: Large;
9977
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DisplaySize>;
9978
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DisplaySize | undefined;
9979
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DisplaySize | undefined;
9980
+ }
9981
+ export type DisplaySize = DisplaySize.Small | DisplaySize.Medium | DisplaySize.Large;
9946
9982
  /**
9947
9983
  * Used by `UIAspectRatioConstraint.DominantAxis` for resizing the object to maintain the aspect ratio.
9948
9984
  *
@@ -19908,7 +19944,7 @@ declare namespace Enum {
19908
19944
  }
19909
19945
  export const Glacier: Glacier;
19910
19946
  /**
19911
- * Applies to `BasePart` only.
19947
+ * Applies to `BasePart` only. Note that refraction of light through this material is not supported on mobile devices due to computational limitations.
19912
19948
  *
19913
19949
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#Glass)
19914
19950
  */
@@ -19919,7 +19955,7 @@ declare namespace Enum {
19919
19955
  }
19920
19956
  export const Glass: Glass;
19921
19957
  /**
19922
- * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example of the **ForceField** material.
19958
+ * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example.
19923
19959
  *
19924
19960
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#ForceField)
19925
19961
  */
@@ -20387,7 +20423,7 @@ declare namespace Enum {
20387
20423
  }
20388
20424
  export const Cylinder: Cylinder;
20389
20425
  /**
20390
- * The mesh is determined by the Roblox mesh asset id provided.
20426
+ * The mesh is determined by the Roblox mesh asset ID provided.
20391
20427
  *
20392
20428
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MeshType#FileMesh)
20393
20429
  */
@@ -20808,7 +20844,7 @@ declare namespace Enum {
20808
20844
  }
20809
20845
  export const Default: Default;
20810
20846
  /**
20811
- * The mouse is locked, and cannot move from, the center of the user's screen.
20847
+ * The mouse is locked and cannot move from the center of the user's screen.
20812
20848
  *
20813
20849
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCenter)
20814
20850
  */
@@ -20819,7 +20855,7 @@ declare namespace Enum {
20819
20855
  }
20820
20856
  export const LockCenter: LockCenter;
20821
20857
  /**
20822
- * The mouse is locked, and cannot move from, it's current position on the user's screen at the time of locking.
20858
+ * The mouse is locked and cannot move from its current position on the user's screen at the time of locking.
20823
20859
  *
20824
20860
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCurrentPosition)
20825
20861
  */
@@ -23499,6 +23535,42 @@ declare namespace Enum {
23499
23535
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptCreateAvatarResult | undefined;
23500
23536
  }
23501
23537
  export type PromptCreateAvatarResult = PromptCreateAvatarResult.Success | PromptCreateAvatarResult.PermissionDenied | PromptCreateAvatarResult.Timeout | PromptCreateAvatarResult.UploadFailed | PromptCreateAvatarResult.NoUserInput | PromptCreateAvatarResult.InvalidHumanoidDescription | PromptCreateAvatarResult.UGCValidationFailed | PromptCreateAvatarResult.ModeratedName | PromptCreateAvatarResult.MaxOutfits | PromptCreateAvatarResult.PurchaseFailure | PromptCreateAvatarResult.UnknownFailure | PromptCreateAvatarResult.TokenInvalid;
23538
+ /**
23539
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult)
23540
+ */
23541
+ export namespace PromptLinkSharingResult {
23542
+ /**
23543
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#Success)
23544
+ */
23545
+ export interface Success extends globalThis.EnumItem {
23546
+ Name: "Success";
23547
+ Value: 1;
23548
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23549
+ }
23550
+ export const Success: Success;
23551
+ /**
23552
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#PlayerLeft)
23553
+ */
23554
+ export interface PlayerLeft extends globalThis.EnumItem {
23555
+ Name: "PlayerLeft";
23556
+ Value: 2;
23557
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23558
+ }
23559
+ export const PlayerLeft: PlayerLeft;
23560
+ /**
23561
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#InvalidLaunchData)
23562
+ */
23563
+ export interface InvalidLaunchData extends globalThis.EnumItem {
23564
+ Name: "InvalidLaunchData";
23565
+ Value: 3;
23566
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23567
+ }
23568
+ export const InvalidLaunchData: InvalidLaunchData;
23569
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PromptLinkSharingResult>;
23570
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PromptLinkSharingResult | undefined;
23571
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptLinkSharingResult | undefined;
23572
+ }
23573
+ export type PromptLinkSharingResult = PromptLinkSharingResult.Success | PromptLinkSharingResult.PlayerLeft | PromptLinkSharingResult.InvalidLaunchData;
23502
23574
  /**
23503
23575
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult)
23504
23576
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.860",
3
+ "version": "1.0.862",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },