@rbxts/types 1.0.606 → 1.0.609

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.
@@ -401,7 +401,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
401
401
  ChatInputBarConfiguration: ChatInputBarConfiguration;
402
402
  ChatWindowConfiguration: ChatWindowConfiguration;
403
403
  CommandInstance: CommandInstance;
404
- CustomDspSoundEffect: CustomDspSoundEffect;
404
+ CustomSoundEffect: CustomSoundEffect;
405
405
  DataModel: DataModel;
406
406
  DataStore: DataStore;
407
407
  DataStoreInfo: DataStoreInfo;
@@ -16207,6 +16207,11 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
16207
16207
  */
16208
16208
  readonly CageNoOverlappingVertices: boolean;
16209
16209
  CageNoOverlappingVerticesPreview: boolean;
16210
+ /**
16211
+ * Tags: ReadOnly, NotReplicated
16212
+ */
16213
+ readonly CageUVMatched: boolean;
16214
+ CageUVMatchedPreview: boolean;
16210
16215
  /**
16211
16216
  * Tags: ReadOnly, NotReplicated
16212
16217
  */
@@ -16217,6 +16222,7 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
16217
16222
  * Tags: ReadOnly, NotReplicated
16218
16223
  */
16219
16224
  readonly PolygonCount: number;
16225
+ UseImportedPivot: boolean;
16220
16226
  }
16221
16227
 
16222
16228
  interface ImporterRootSettings extends ImporterBaseSettings {
@@ -29344,7 +29350,7 @@ interface CompressorSoundEffect extends SoundEffect {
29344
29350
  Threshold: number;
29345
29351
  }
29346
29352
 
29347
- interface CustomDspSoundEffect extends SoundEffect {
29353
+ interface CustomSoundEffect extends SoundEffect {
29348
29354
  /**
29349
29355
  * **DO NOT USE!**
29350
29356
  *
@@ -29352,10 +29358,10 @@ interface CustomDspSoundEffect extends SoundEffect {
29352
29358
  * @hidden
29353
29359
  * @deprecated
29354
29360
  */
29355
- readonly _nominal_CustomDspSoundEffect: unique symbol;
29361
+ readonly _nominal_CustomSoundEffect: unique symbol;
29356
29362
  }
29357
29363
 
29358
- interface ChannelSelectorSoundEffect extends CustomDspSoundEffect {
29364
+ interface ChannelSelectorSoundEffect extends CustomSoundEffect {
29359
29365
  /**
29360
29366
  * **DO NOT USE!**
29361
29367
  *
@@ -197,18 +197,12 @@ interface CoreGui extends BasePlayerGui {
197
197
  * @deprecated
198
198
  */
199
199
  readonly _nominal_CoreGui: unique symbol;
200
- /**
201
- * Overrides the default selection adornment (used for gamepads). For best results, this should point to a GuiObject.
202
- */
203
200
  readonly SelectionImageObject: GuiObject | undefined;
204
201
  /**
205
202
  * The current version of the CoreGui. Everytime the CoreGui is majorly changed, this number is increased.
206
203
  * Tags: ReadOnly, NotReplicated
207
204
  */
208
205
  readonly Version: number;
209
- /**
210
- * When enabled, forces the contents of the [PlayerGui](https://developer.roblox.com/en-us/api-reference/class/PlayerGui) to be rendered like a [SurfaceGui](https://developer.roblox.com/en-us/api-reference/class/SurfaceGui) adorned to a [Part](https://developer.roblox.com/en-us/api-reference/class/Part)'s face. This is used for VR.
211
- */
212
206
  SetUserGuiRendering(this: CoreGui, enabled: boolean, guiAdornee: Instance, faceId: CastsToEnum<Enum.NormalId>): void;
213
207
  TakeScreenshot(this: CoreGui): void;
214
208
  ToggleRecording(this: CoreGui): void;
@@ -779,9 +773,6 @@ interface GameSettings extends Instance {
779
773
  * Tags: NotReplicated
780
774
  */
781
775
  readonly VideoRecording: boolean;
782
- /**
783
- * The VideoRecordingChangeRequest event fires when the user starts or stops recording.
784
- */
785
776
  readonly VideoRecordingChangeRequest: RBXScriptSignal<(recording: boolean) => void>;
786
777
  }
787
778
 
@@ -1760,12 +1751,10 @@ interface Plugin extends Instance {
1760
1751
  */
1761
1752
  readonly GridSize: number;
1762
1753
  /**
1763
- * This member is for a feature that is not yet released.
1764
1754
  * Tags: Hidden, ReadOnly, NotReplicated
1765
1755
  */
1766
1756
  readonly HostDataModelType: Enum.StudioDataModelType;
1767
1757
  /**
1768
- * This member is for a feature that is not yet released.
1769
1758
  * Tags: Hidden, ReadOnly, NotReplicated
1770
1759
  */
1771
1760
  readonly HostDataModelTypeIsCurrent: boolean;
@@ -1849,9 +1838,6 @@ interface Plugin extends Instance {
1849
1838
  * * [Plugin.Unloading](https://developer.roblox.com/en-us/api-reference/event/Plugin/Unloading), fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating
1850
1839
  */
1851
1840
  Deactivate(this: Plugin): void;
1852
- /**
1853
- * This member is for a feature that is not yet released.
1854
- */
1855
1841
  GetItem(this: Plugin, key: string, defaultValue: unknown): unknown;
1856
1842
  /**
1857
1843
  * Returns the [JointCreationMode](https://developer.roblox.com/en-us/api-reference/enum/JointCreationMode) the user has set in studio under the Model tab.
@@ -1904,17 +1890,8 @@ interface Plugin extends Instance {
1904
1890
  * Opens the context help window to the wiki page that `url` links to.
1905
1891
  */
1906
1892
  OpenWikiPage(this: Plugin, url: string): void;
1907
- /**
1908
- * Pauses a sound that was played via [Plugin:PlaySound](https://developer.roblox.com/en-us/api-reference/function/Plugin/PlaySound).
1909
- */
1910
1893
  PauseSound(this: Plugin, sound: Sound): void;
1911
- /**
1912
- * PlaySound allows you to play a [Sound](https://developer.roblox.com/en-us/api-reference/class/Sound) object regardless if the game is running or not.
1913
- */
1914
1894
  PlaySound(this: Plugin, sound: Sound, normalizedTimePosition?: number): void;
1915
- /**
1916
- * Resumes a sound that was previously being played (via [Plugin:PlaySound](https://developer.roblox.com/en-us/api-reference/function/Plugin/PlaySound)).
1917
- */
1918
1895
  ResumeSound(this: Plugin, sound: Sound): void;
1919
1896
  /**
1920
1897
  * Opens an upload window for the user's current selection.
@@ -1935,9 +1912,6 @@ interface Plugin extends Instance {
1935
1912
  * Separates the given UnionOperations and returns the resulting parts.
1936
1913
  */
1937
1914
  Separate(this: Plugin, objects: Array<Instance>): Array<Instance>;
1938
- /**
1939
- * This member is for a feature that is not yet released.
1940
- */
1941
1915
  SetItem(this: Plugin, key: string, value: unknown): void;
1942
1916
  SetReady(this: Plugin): void;
1943
1917
  /**
@@ -2014,9 +1988,6 @@ interface Plugin extends Instance {
2014
1988
  * * [PluginGui.PluginDragLeft](https://developer.roblox.com/en-us/api-reference/event/PluginGui/PluginDragLeft)
2015
1989
  */
2016
1990
  StartDrag(this: Plugin, dragData: object): void;
2017
- /**
2018
- * Forces all sounds that are being played by the plugin to stop playing.
2019
- */
2020
1991
  StopAllSounds(this: Plugin): void;
2021
1992
  /**
2022
1993
  * Unions the given parts and returns the resulting UnionOperation.
@@ -2561,56 +2532,22 @@ interface RenderingTest extends Instance {
2561
2532
  * @deprecated
2562
2533
  */
2563
2534
  readonly _nominal_RenderingTest: unique symbol;
2564
- /**
2565
- * The CFrame that the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) will use when this RenderingTest is executed.
2566
- * The value of this property is reflected into [RenderingTest.Position](https://developer.roblox.com/en-us/api-reference/property/RenderingTest/Position) and [RenderingTest.Orientation](https://developer.roblox.com/en-us/api-reference/property/RenderingTest/Orientation).
2567
- */
2568
2535
  CFrame: CFrame;
2569
- /**
2570
- * The maximum difference that this RenderingTest can have between the image it captures and the original image.
2571
- * This property is only used if the RenderingTest's ComparisonMethod is set to **diff**.
2572
- */
2573
2536
  ComparisonDiffThreshold: number;
2574
- /**
2575
- * The comparison method that is expected to be used when this RenderingTest's image capture is compared to its original image.
2576
- */
2577
2537
  ComparisonMethod: Enum.RenderingTestComparisonMethod;
2578
- /**
2579
- * The maximum peak signal-to-noise ratio that this RenderingTest can have between the image it captures and the original image.
2580
- * This property is only used if the RenderingTest's ComparisonMethod is set to **psnr**.
2581
- */
2582
2538
  ComparisonPsnrThreshold: number;
2583
- /**
2584
- * A description to describe this RenderingTest.
2585
- */
2586
2539
  Description: string;
2587
- /**
2588
- * The FieldOfView that will be used by the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) when running this RenderingTest.
2589
- * Should fall between 1 and 120 in order to work as expected.
2590
- */
2591
2540
  FieldOfView: number;
2592
2541
  /**
2593
- * The derived orientation of the RenderingTest's CFrame.
2594
2542
  * Tags: NotReplicated
2595
2543
  */
2596
2544
  Orientation: Vector3;
2597
2545
  /**
2598
- * The derived position of the RenderingTest's CFrame.
2599
2546
  * Tags: NotReplicated
2600
2547
  */
2601
2548
  Position: Vector3;
2602
- /**
2603
- * The graphics quality that will be used by the rendering pipeline when running this RenderingTest.
2604
- * Should fall between 1 and 21 in order to work as expected.
2605
- */
2606
2549
  QualityLevel: number;
2607
- /**
2608
- * Indicates whether or not this RenderingTest should be skipped.
2609
- */
2610
2550
  ShouldSkip: boolean;
2611
- /**
2612
- * A label of the internal JIRA ticket this RenderingTest is associated with.
2613
- */
2614
2551
  Ticket: string;
2615
2552
  RenderdocTriggerCapture(this: RenderingTest): void;
2616
2553
  }
@@ -11,6 +11,7 @@ interface EnumItem {
11
11
  Name: string;
12
12
  Value: number;
13
13
  EnumType: Enum;
14
+ IsA<T extends keyof Enums>(this: defined, name: T): this is Enums[T];
14
15
  }
15
16
 
16
17
  interface Enum {
@@ -3098,6 +3099,14 @@ declare namespace Enum {
3098
3099
 
3099
3100
  export const OK: OK;
3100
3101
 
3102
+ export interface Unknown {
3103
+ Name: "Unknown";
3104
+ Value: 1;
3105
+ EnumType: EnumType<ConnectionError>;
3106
+ }
3107
+
3108
+ export const Unknown: Unknown;
3109
+
3101
3110
  export interface DisconnectErrors {
3102
3111
  Name: "DisconnectErrors";
3103
3112
  Value: 256;
@@ -3540,7 +3549,7 @@ declare namespace Enum {
3540
3549
 
3541
3550
  export function GetEnumItems(this: defined): Array<ConnectionError>
3542
3551
  }
3543
- export type ConnectionError = ConnectionError.OK | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectOutOfMemory | ConnectionError.DisconnectModeratedGame | ConnectionError.DisconnectOutOfMemoryExitContinue | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
3552
+ export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectOutOfMemory | ConnectionError.DisconnectModeratedGame | ConnectionError.DisconnectOutOfMemoryExitContinue | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
3544
3553
  export namespace ConnectionState {
3545
3554
  export interface Connected {
3546
3555
  Name: "Connected";
package/include/lua.d.ts CHANGED
@@ -47,55 +47,37 @@ declare function tonumber(arg: unknown, base?: number): number | undefined;
47
47
  /** Receives an argument of any type and converts it to a string in a reasonable format. If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as an argument and uses the result of the call as its result. For complete control of how numbers are converted, use string.format. */
48
48
  declare function tostring(value: unknown): string;
49
49
 
50
- /** Calls the function func with the given arguments in protected mode. This means that any error inside func is not propagated; instead, pcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message. */
51
- declare function pcall<T extends Array<any>, U>(
52
- func: (...args: T) => U,
53
- ): LuaTuple<
54
- U extends [infer A]
55
- ? [true, A] | [false, unknown]
56
- : U extends [infer A, infer B]
57
- ? [true, A, B] | [false, unknown, undefined]
58
- : U extends [infer A, infer B, infer C]
59
- ? [true, A, B, C] | [false, unknown, undefined, undefined]
60
- : U extends [infer A, infer B, infer C, infer D]
61
- ? [true, A, B, C, D] | [false, unknown, undefined, undefined, undefined]
62
- : U extends [infer A, infer B, infer C, infer D, infer E]
63
- ? [true, A, B, C, D, E] | [false, unknown, undefined, undefined, undefined, undefined]
64
- : U extends [infer A, infer B, infer C, infer D, infer E, infer F]
65
- ? [true, A, B, C, D, E, F] | [false, unknown, undefined, undefined, undefined, undefined, undefined]
66
- : [true, U] | [false, unknown]
67
- >;
68
-
69
- /** Calls the function func with the given arguments in protected mode. This means that any error inside func is not propagated; instead, pcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message. */
50
+ /**
51
+ * Calls the function `func` with the given arguments in protected mode. This means that any error inside `func` is not
52
+ * propagated; instead, pcall catches the error and returns a status code. Its first result is the status code
53
+ * (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the
54
+ * call, after this first result. In case of any error, pcall returns false plus the error message.
55
+ */
56
+ declare function pcall<T extends Array<any>, U extends Array<any>>(
57
+ func: (...args: T) => LuaTuple<U>,
58
+ ...args: T
59
+ ): LuaTuple<[true, ...U] | [false, ...{ [K in keyof U]: K extends "0" ? unknown : undefined }]>;
70
60
  declare function pcall<T extends Array<any>, U>(
71
61
  func: (...args: T) => U,
72
62
  ...args: T
73
- ): LuaTuple<
74
- U extends [infer A]
75
- ? [true, A] | [false, unknown]
76
- : U extends [infer A, infer B]
77
- ? [true, A, B] | [false, unknown, undefined]
78
- : U extends [infer A, infer B, infer C]
79
- ? [true, A, B, C] | [false, unknown, undefined, undefined]
80
- : U extends [infer A, infer B, infer C, infer D]
81
- ? [true, A, B, C, D] | [false, unknown, undefined, undefined, undefined]
82
- : U extends [infer A, infer B, infer C, infer D, infer E]
83
- ? [true, A, B, C, D, E] | [false, unknown, undefined, undefined, undefined, undefined]
84
- : U extends [infer A, infer B, infer C, infer D, infer E, infer F]
85
- ? [true, A, B, C, D, E, F] | [false, unknown, undefined, undefined, undefined, undefined, undefined]
86
- : [true, U] | [false, unknown]
87
- >;
88
-
89
- /** Calls the function func with the given arguments in protected mode. This means that any error inside func is not propagated; instead, xpcall catches the error and returns a status code. Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, xpcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the error message. */
90
- declare function xpcall<T extends Array<unknown>, U, V>(
63
+ ): LuaTuple<[true, U] | [false, unknown]>;
64
+
65
+ /**
66
+ * Calls the function `func` with the given arguments in protected mode. This means that any error inside `func` is not
67
+ * propagated; instead, xpcall catches the error and returns a status code. Its first result is the status code
68
+ * (a boolean), which is true if the call succeeds without errors. In such case, xpcall also returns all results from
69
+ * the call, after this first result. In case of any error, pcall returns false plus the error message.
70
+ */
71
+ declare function xpcall<T extends Array<any>, U extends Array<any>, V>(
72
+ func: (...args: T) => LuaTuple<U>,
73
+ errHandler: (err: unknown) => V,
74
+ ...args: T
75
+ ): LuaTuple<[true, ...U] | [false, ...{ [K in keyof U]: K extends "0" ? V : undefined }]>;
76
+ declare function xpcall<T extends Array<any>, U, V>(
91
77
  func: (...args: T) => U,
92
78
  errHandler: (err: unknown) => V,
93
79
  ...args: T
94
- ): LuaTuple<
95
- U extends LuaTuple<[...infer W]>
96
- ? [true, ...W] | [false, V extends LuaTuple<[infer A, ...Array<unknown>]> ? A : V]
97
- : [true, U] | [false, V extends LuaTuple<[infer A, ...Array<unknown>]> ? A : V]
98
- >;
80
+ ): LuaTuple<[true, U] | [false, V]>;
99
81
 
100
82
  interface LuaMetatable<T> {
101
83
  __index?: (self: T, index: unknown) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.606",
3
+ "version": "1.0.609",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },