@rbxts/types 1.0.679 → 1.0.681

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.
@@ -153,7 +153,7 @@ interface Animator extends Instance {
153
153
  *
154
154
  * Developers designing their own custom animation editors are advised to use this function to preview animations, as it is the method the official Roblox Animation Editor plugin uses.
155
155
  */
156
- StepAnimations(this: Animator, deltaTime: number): null;
156
+ StepAnimations(this: Animator, deltaTime: number): void;
157
157
  }
158
158
 
159
159
  /** The CoreGui is a service used to store Guis created in-game by Roblox for the core user interface found in every game (such as the game menu, the playerlist, the backpack, etc.). It can also be used by [Plugins](https://developer.roblox.com/en-us/api-reference/class/Plugin) in Roblox Studio.
@@ -217,23 +217,23 @@ interface ChangeHistoryService extends Instance {
217
217
  /**
218
218
  * Executes the last action that was undone.
219
219
  */
220
- Redo(this: ChangeHistoryService): null;
220
+ Redo(this: ChangeHistoryService): void;
221
221
  /**
222
222
  * Clears the history, causing all undo/redo waypoints to be removed.
223
223
  */
224
- ResetWaypoints(this: ChangeHistoryService): null;
224
+ ResetWaypoints(this: ChangeHistoryService): void;
225
225
  /**
226
226
  * Sets whether or not the ChangeHistoryService is enabled. When set to false, the undo/redo list is cleared, and does not repopulate. When set to true again, the original list is not restored, but further operations append to the list once more
227
227
  */
228
- SetEnabled(this: ChangeHistoryService, state: boolean): null;
228
+ SetEnabled(this: ChangeHistoryService, state: boolean): void;
229
229
  /**
230
230
  * Sets a new waypoint which can be used as an undo or redo point.
231
231
  */
232
- SetWaypoint(this: ChangeHistoryService, name: string): null;
232
+ SetWaypoint(this: ChangeHistoryService, name: string): void;
233
233
  /**
234
234
  * Undos the last action taken, for which there exists a waypoint.
235
235
  */
236
- Undo(this: ChangeHistoryService): null;
236
+ Undo(this: ChangeHistoryService): void;
237
237
  /**
238
238
  * Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.
239
239
  */
@@ -374,25 +374,25 @@ interface DebuggerManager extends Instance {
374
374
  /**
375
375
  * Resumes the Lua Debugger if it is paused.
376
376
  */
377
- Resume(this: DebuggerManager): null;
377
+ Resume(this: DebuggerManager): void;
378
378
  /**
379
379
  * Performs a [step into](https://developer.roblox.com/articles/Lua-debugger "Lua Debugger") operation on the Lua Debugger.
380
380
  * Tags: Deprecated
381
381
  * @deprecated
382
382
  */
383
- StepIn(this: DebuggerManager): null;
383
+ StepIn(this: DebuggerManager): void;
384
384
  /**
385
385
  * Performs a [step out](https://developer.roblox.com/articles/Lua-debugger "Lua Debugger") operation on the Lua Debugger.
386
386
  * Tags: Deprecated
387
387
  * @deprecated
388
388
  */
389
- StepOut(this: DebuggerManager): null;
389
+ StepOut(this: DebuggerManager): void;
390
390
  /**
391
391
  * Performs a [step over](https://developer.roblox.com/articles/Lua-debugger "Lua Debugger") operation on the Lua Debugger.
392
392
  * Tags: Deprecated
393
393
  * @deprecated
394
394
  */
395
- StepOver(this: DebuggerManager): null;
395
+ StepOver(this: DebuggerManager): void;
396
396
  /**
397
397
  * Fires when a new [ScriptDebugger](https://developer.roblox.com/en-us/api-reference/class/ScriptDebugger) is created through the [DebuggerManager:AddDebugger](https://developer.roblox.com/en-us/api-reference/function/DebuggerManager/AddDebugger) method.
398
398
  */
@@ -787,7 +787,7 @@ interface PluginGui extends LayerCollector {
787
787
  * * [Plugin:CreateDockWidgetPluginGui](https://developer.roblox.com/en-us/api-reference/function/Plugin/CreateDockWidgetPluginGui) to create a [PluginGui](https://developer.roblox.com/en-us/api-reference/class/PluginGui)
788
788
  * * [DataModel:BindToClose](https://developer.roblox.com/en-us/api-reference/function/DataModel/BindToClose), which can be used to bind a function to the game ending and should not be confused with this function
789
789
  */
790
- BindToClose(this: PluginGui, callback?: Callback): null;
790
+ BindToClose(this: PluginGui, callback?: Callback): void;
791
791
  /**
792
792
  * GetRelativeMousePosition returns the position of the mouse relative to the top-left corner of the [PluginGui](https://developer.roblox.com/en-us/api-reference/class/PluginGui). The returned value changes only if a mouse input began on the PluginGui, or if the mouse is presently hovering over the window.
793
793
  *
@@ -1018,7 +1018,7 @@ interface MemStorageConnection extends Instance {
1018
1018
  * @deprecated
1019
1019
  */
1020
1020
  readonly _nominal_MemStorageConnection: unique symbol;
1021
- Disconnect(this: MemStorageConnection): null;
1021
+ Disconnect(this: MemStorageConnection): void;
1022
1022
  }
1023
1023
 
1024
1024
  /** The PluginMouse object gives [Plugin](https://developer.roblox.com/en-us/api-reference/class/Plugin)s access to the mouse. It works like the [Mouse](https://developer.roblox.com/en-us/api-reference/class/Mouse) object and can be obtained using the plugin [Plugin:GetMouse](https://developer.roblox.com/en-us/api-reference/function/Plugin/GetMouse) method.
@@ -1068,7 +1068,7 @@ interface NetworkPeer extends Instance {
1068
1068
  /**
1069
1069
  * Sets the maximum outgoing bandwidth that Roblox can use.
1070
1070
  */
1071
- SetOutgoingKBPSLimit(this: NetworkPeer, limit: number): null;
1071
+ SetOutgoingKBPSLimit(this: NetworkPeer, limit: number): void;
1072
1072
  }
1073
1073
 
1074
1074
  /** This service is responsible for connecting a client to a server. */
@@ -1245,7 +1245,7 @@ interface Terrain extends BasePart {
1245
1245
  * Tags: Deprecated
1246
1246
  * @deprecated
1247
1247
  */
1248
- ConvertToSmooth(this: Terrain): null;
1248
+ ConvertToSmooth(this: Terrain): void;
1249
1249
  }
1250
1250
 
1251
1251
  interface Model extends PVInstance {
@@ -1280,7 +1280,7 @@ interface WorldRoot extends Model {
1280
1280
  * * If translate stiffness and rotate stiffness are both equal to 0.5, then the part will try to move to exactly the target CFrame, but may be pushed out of the way by physical constraints on it.
1281
1281
  * * If translate stiffness and rotate stiffness are both equal to 0, then the target CFrame will be ignored and physical constraints will be solved for the object at the position where it was.
1282
1282
  */
1283
- IKMoveTo(this: WorldRoot, part: BasePart, target: CFrame, translateStiffness?: number, rotateStiffness?: number, collisionsMode?: CastsToEnum<Enum.IKCollisionsMode>): null;
1283
+ IKMoveTo(this: WorldRoot, part: BasePart, target: CFrame, translateStiffness?: number, rotateStiffness?: number, collisionsMode?: CastsToEnum<Enum.IKCollisionsMode>): void;
1284
1284
  }
1285
1285
 
1286
1286
  interface Workspace extends WorldRoot {
@@ -1340,7 +1340,7 @@ interface Workspace extends WorldRoot {
1340
1340
  *
1341
1341
  * This function cannot be used in scripts but will function in the command bar or plugins.
1342
1342
  */
1343
- ZoomToExtents(this: Workspace): null;
1343
+ ZoomToExtents(this: Workspace): void;
1344
1344
  }
1345
1345
 
1346
1346
  interface PackageService extends Instance {
@@ -1615,7 +1615,7 @@ interface Player extends Instance {
1615
1615
  *
1616
1616
  * This does not set the age of the player on the account, but the age of the account itself relative to when it was first created.
1617
1617
  */
1618
- SetAccountAge(this: Player, accountAge: number): null;
1618
+ SetAccountAge(this: Player, accountAge: number): void;
1619
1619
  /**
1620
1620
  * The SetSuperSafeChat [Player](https://developer.roblox.com/en-us/api-reference/class/Player) function sets whether or not the player sees chat filtered by [TextService](https://developer.roblox.com/en-us/api-reference/class/TextService)'s [TextService:FilterStringAsync](https://developer.roblox.com/en-us/api-reference/function/TextService/FilterStringAsync) rather than normal chats.
1621
1621
  *
@@ -1630,7 +1630,7 @@ interface Player extends Instance {
1630
1630
  *
1631
1631
  * Regardless of whether a player has SuperSafeChat enabled, all chat should be filtered by TextService when broadcasted to other players or on the player's own screen. [TextService:FilterStringAsync](https://developer.roblox.com/en-us/api-reference/function/TextService/FilterStringAsync) returns a [TextFilterResult](https://developer.roblox.com/en-us/api-reference/class/TextFilterResult) object that can be filtered differently according to the message's intended use.
1632
1632
  */
1633
- SetSuperSafeChat(this: Player, value: boolean): null;
1633
+ SetSuperSafeChat(this: Player, value: boolean): void;
1634
1634
  }
1635
1635
 
1636
1636
  interface Players extends Instance {
@@ -1652,7 +1652,7 @@ interface Players extends Instance {
1652
1652
  *
1653
1653
  * * [Lua Chat System](https://developer.roblox.com/en-us/articles/lua-chat-system), a tutorial for creating a more advanced chat system
1654
1654
  */
1655
- Chat(this: Players, message: string): null;
1655
+ Chat(this: Players, message: string): void;
1656
1656
  /**
1657
1657
  * This function sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and Chat what to do using the `ChatStyle` enum. Since this item is protected, attempting to use it in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) will cause an error.
1658
1658
  *
@@ -1665,7 +1665,7 @@ interface Players extends Instance {
1665
1665
  *
1666
1666
  * Developers who are interested interested in configuring their games' bubble chat system even further should take a look at the [Bubble Chat](https://developer.roblox.com/en-us/articles/bubble-chat) article.
1667
1667
  */
1668
- SetChatStyle(this: Players, style?: CastsToEnum<Enum.ChatStyle>): null;
1668
+ SetChatStyle(this: Players, style?: CastsToEnum<Enum.ChatStyle>): void;
1669
1669
  /**
1670
1670
  * This function makes the [Players.LocalPlayer](https://developer.roblox.com/en-us/api-reference/property/Players/LocalPlayer) chat the given message, which will only be viewable by users on the same team. Since this item is protected, attempting to use it in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) or [LocalScript](https://developer.roblox.com/en-us/api-reference/class/LocalScript) will cause an error.
1671
1671
  *
@@ -1673,7 +1673,7 @@ interface Players extends Instance {
1673
1673
  *
1674
1674
  * If you would like to create a custom chat system where you can define custom functions such as these, take a look at the tutorial [here](https://developer.roblox.com/articles/Lua-Chat-System).
1675
1675
  */
1676
- TeamChat(this: Players, message: string): null;
1676
+ TeamChat(this: Players, message: string): void;
1677
1677
  }
1678
1678
 
1679
1679
  /** Plugin is the main object responsible for creating basic studio widgets. It is a custom add-on to Studio which adds new behavior and features that are not normally included.
@@ -1726,7 +1726,7 @@ interface Plugin extends Instance {
1726
1726
  * * [Plugin:IsActivatedWithExclusiveMouse](https://developer.roblox.com/en-us/api-reference/function/Plugin/IsActivatedWithExclusiveMouse), returns true if this plugin is currently active with an exclusive mouse, after having been activated via this function
1727
1727
  * * [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
1728
1728
  */
1729
- Activate(this: Plugin, exclusiveMouse: boolean): null;
1729
+ Activate(this: Plugin, exclusiveMouse: boolean): void;
1730
1730
  /**
1731
1731
  * This function creates a [PluginAction](https://developer.roblox.com/en-us/api-reference/class/PluginAction) which is an object that represents a generic performable action in Roblox Studio, with no directly associated `Toolbar` or `Button`. In Roblox Studio, they can be assigned a keyboard shortcut under `File → Advanced → Customize Shortcuts…`, and they can also be added to the Quick Access Toolbar.
1732
1732
  *
@@ -1786,7 +1786,7 @@ interface Plugin extends Instance {
1786
1786
  * * [Plugin.Deactivation](https://developer.roblox.com/en-us/api-reference/event/Plugin/Deactivation), fires when the plugin is deactivated
1787
1787
  * * [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
1788
1788
  */
1789
- Deactivate(this: Plugin): null;
1789
+ Deactivate(this: Plugin): void;
1790
1790
  /**
1791
1791
  * Returns the [JointCreationMode](https://developer.roblox.com/en-us/api-reference/enum/JointCreationMode) the user has set in studio under the Model tab.
1792
1792
  */
@@ -1831,15 +1831,15 @@ interface Plugin extends Instance {
1831
1831
  /**
1832
1832
  * Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 0.
1833
1833
  */
1834
- OpenScript(this: Plugin, script: LuaSourceContainer, lineNumber?: number): null;
1834
+ OpenScript(this: Plugin, script: LuaSourceContainer, lineNumber?: number): void;
1835
1835
  /**
1836
1836
  * Opens the context help window to the wiki page that `url` links to.
1837
1837
  */
1838
- OpenWikiPage(this: Plugin, url: string): null;
1838
+ OpenWikiPage(this: Plugin, url: string): void;
1839
1839
  /**
1840
1840
  * Opens an upload window for the user's current selection.
1841
1841
  */
1842
- SaveSelectedToRoblox(this: Plugin): null;
1842
+ SaveSelectedToRoblox(this: Plugin): void;
1843
1843
  /**
1844
1844
  * Activates the specified Roblox Studio tool.
1845
1845
  * If the tool opens a window, the position parameter specifies where it should be shown on the screen.
@@ -1850,7 +1850,7 @@ interface Plugin extends Instance {
1850
1850
  * * An object must be selected in order for this to work correctly.
1851
1851
  * * Altering the scale fields of the _position_ property will not affect the dialog popups.
1852
1852
  */
1853
- SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): null;
1853
+ SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): void;
1854
1854
  /**
1855
1855
  * Separates the given UnionOperations and returns the resulting parts.
1856
1856
  */
@@ -1858,7 +1858,7 @@ interface Plugin extends Instance {
1858
1858
  /**
1859
1859
  * Stores a given value for later use under the given key. The value will persist even after studio is closed.
1860
1860
  */
1861
- SetSetting(this: Plugin, key: string, value: unknown): null;
1861
+ SetSetting(this: Plugin, key: string, value: unknown): void;
1862
1862
  /**
1863
1863
  * **StartDrag** initiates a drag action using a dictionary of parameters. The parameters are as follows:
1864
1864
  *
@@ -1927,7 +1927,7 @@ interface Plugin extends Instance {
1927
1927
  * * [PluginGui.PluginDragDropped](https://developer.roblox.com/en-us/api-reference/event/PluginGui/PluginDragDropped)
1928
1928
  * * [PluginGui.PluginDragLeft](https://developer.roblox.com/en-us/api-reference/event/PluginGui/PluginDragLeft)
1929
1929
  */
1930
- StartDrag(this: Plugin, dragData: object): null;
1930
+ StartDrag(this: Plugin, dragData: object): void;
1931
1931
  /**
1932
1932
  * Unions the given parts and returns the resulting UnionOperation.
1933
1933
  */
@@ -2098,8 +2098,8 @@ interface PluginManagerInterface extends Instance {
2098
2098
  * @deprecated
2099
2099
  */
2100
2100
  CreatePlugin(this: PluginManagerInterface): Instance | undefined;
2101
- ExportPlace(this: PluginManagerInterface, filePath?: string): null;
2102
- ExportSelection(this: PluginManagerInterface, filePath?: string): null;
2101
+ ExportPlace(this: PluginManagerInterface, filePath?: string): void;
2102
+ ExportSelection(this: PluginManagerInterface, filePath?: string): void;
2103
2103
  }
2104
2104
 
2105
2105
  /** A context menu that can be shown in Studio. It displays a list of PluginActions and supports submenus.
@@ -2222,7 +2222,7 @@ interface PluginMenu extends Instance {
2222
2222
  * * [PluginMenu:Clear](https://developer.roblox.com/en-us/api-reference/function/PluginMenu/Clear), clears the menu
2223
2223
  * * [PluginMenu:ShowAsync](https://developer.roblox.com/en-us/api-reference/function/PluginMenu/ShowAsync), shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event
2224
2224
  */
2225
- AddSeparator(this: PluginMenu): null;
2225
+ AddSeparator(this: PluginMenu): void;
2226
2226
  /**
2227
2227
  * This function clears the menu
2228
2228
  *
@@ -2240,7 +2240,7 @@ interface PluginMenu extends Instance {
2240
2240
  * * [PluginMenu:AddSeparator](https://developer.roblox.com/en-us/api-reference/function/PluginMenu/AddSeparator), adds a separator between items in the menu
2241
2241
  * * [PluginMenu:ShowAsync](https://developer.roblox.com/en-us/api-reference/function/PluginMenu/ShowAsync), shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed. The selected action fires its Triggered event
2242
2242
  */
2243
- Clear(this: PluginMenu): null;
2243
+ Clear(this: PluginMenu): void;
2244
2244
  /**
2245
2245
  * This function shows the menu at the mouse cursor. It yields until either an item is selected or the menu is closed. The selected action fires its [PluginAction.Triggered](https://developer.roblox.com/en-us/api-reference/event/PluginAction/Triggered) event
2246
2246
  *
@@ -2352,7 +2352,7 @@ interface PluginToolbarButton extends Instance {
2352
2352
  * Tags: NotReplicated
2353
2353
  */
2354
2354
  Icon: string;
2355
- SetActive(this: PluginToolbarButton, active: boolean): null;
2355
+ SetActive(this: PluginToolbarButton, active: boolean): void;
2356
2356
  /**
2357
2357
  * **Click** fires when the PluginToolbarButton is pressed and released by the user.
2358
2358
  *
@@ -2464,6 +2464,7 @@ interface RenderingTest extends Instance {
2464
2464
  * Tags: Hidden, NotReplicated
2465
2465
  */
2466
2466
  Orientation: Vector3;
2467
+ PerfTest: boolean;
2467
2468
  /**
2468
2469
  * Tags: Hidden, NotReplicated
2469
2470
  */
@@ -2471,7 +2472,7 @@ interface RenderingTest extends Instance {
2471
2472
  QualityLevel: number;
2472
2473
  ShouldSkip: boolean;
2473
2474
  Ticket: string;
2474
- RenderdocTriggerCapture(this: RenderingTest): null;
2475
+ RenderdocTriggerCapture(this: RenderingTest): void;
2475
2476
  }
2476
2477
 
2477
2478
  interface RobloxPluginGuiService extends Instance {
@@ -2523,13 +2524,13 @@ interface RunService extends Instance {
2523
2524
  * * [RunService:Run](https://developer.roblox.com/en-us/api-reference/function/RunService/Run)
2524
2525
  * * [RunService:Stop](https://developer.roblox.com/en-us/api-reference/function/RunService/Stop)
2525
2526
  */
2526
- Pause(this: RunService): null;
2527
+ Pause(this: RunService): void;
2527
2528
  /**
2528
2529
  * The Reset function resets the current game to a waypoint set when Run was called. This method should only be used after Run was called.
2529
2530
  * Tags: Deprecated
2530
2531
  * @deprecated
2531
2532
  */
2532
- Reset(this: RunService): null;
2533
+ Reset(this: RunService): void;
2533
2534
  /**
2534
2535
  * This function runs the game's simulation, running physics and scripts.
2535
2536
  *
@@ -2546,7 +2547,7 @@ interface RunService extends Instance {
2546
2547
  * * [RunService:Pause](https://developer.roblox.com/en-us/api-reference/function/RunService/Pause)
2547
2548
  * * [RunService:Stop](https://developer.roblox.com/en-us/api-reference/function/RunService/Stop)
2548
2549
  */
2549
- Run(this: RunService): null;
2550
+ Run(this: RunService): void;
2550
2551
  /**
2551
2552
  * This function ends the game's simulation if it is running.
2552
2553
  *
@@ -2561,7 +2562,7 @@ interface RunService extends Instance {
2561
2562
  * * [RunService:Run](https://developer.roblox.com/en-us/api-reference/function/RunService/Run)
2562
2563
  * * [RunService:Pause](https://developer.roblox.com/en-us/api-reference/function/RunService/Pause)
2563
2564
  */
2564
- Stop(this: RunService): null;
2565
+ Stop(this: RunService): void;
2565
2566
  }
2566
2567
 
2567
2568
  interface ScriptContext extends Instance {
@@ -2576,7 +2577,7 @@ interface ScriptContext extends Instance {
2576
2577
  /**
2577
2578
  * Limits how long a script is allowed to run without yielding.
2578
2579
  */
2579
- SetTimeout(this: ScriptContext, seconds: number): null;
2580
+ SetTimeout(this: ScriptContext, seconds: number): void;
2580
2581
  }
2581
2582
 
2582
2583
  /** A ScriptDebugger is used to handle the debugging of a specific script. It can be retrieved from the [DebuggerManager](https://developer.roblox.com/en-us/api-reference/class/DebuggerManager). */
@@ -2649,15 +2650,15 @@ interface ScriptDebugger extends Instance {
2649
2650
  /**
2650
2651
  * Sets the value of the variable _name_ as _value_ in the global environment of the specified stack frame.
2651
2652
  */
2652
- SetGlobal(this: ScriptDebugger, name: string, value: unknown, stackFrame: number): null;
2653
+ SetGlobal(this: ScriptDebugger, name: string, value: unknown, stackFrame: number): void;
2653
2654
  /**
2654
2655
  * Sets the value of the variable _name_ as _value_ in the specified stack frame.
2655
2656
  */
2656
- SetLocal(this: ScriptDebugger, name: string, value: unknown, stackFrame?: number): null;
2657
+ SetLocal(this: ScriptDebugger, name: string, value: unknown, stackFrame?: number): void;
2657
2658
  /**
2658
2659
  * Sets the value of the upvalue _name_ as _value_ in the specified stack frame.
2659
2660
  */
2660
- SetUpvalue(this: ScriptDebugger, name: string, value: unknown, stackFrame?: number): null;
2661
+ SetUpvalue(this: ScriptDebugger, name: string, value: unknown, stackFrame?: number): void;
2661
2662
  /**
2662
2663
  * Fires when a [DebuggerBreakpoint](https://developer.roblox.com/en-us/api-reference/class/DebuggerBreakpoint) is added to the script.
2663
2664
  */
@@ -2733,12 +2734,13 @@ interface ScriptEditorService extends Instance {
2733
2734
  * @deprecated
2734
2735
  */
2735
2736
  readonly _nominal_ScriptEditorService: unique symbol;
2736
- DeregisterAutocompleteCallback(this: ScriptEditorService, name: string): null;
2737
- DeregisterScriptAnalysisCallback(this: ScriptEditorService, name: string): null;
2737
+ DeregisterAutocompleteCallback(this: ScriptEditorService, name: string): void;
2738
+ DeregisterScriptAnalysisCallback(this: ScriptEditorService, name: string): void;
2738
2739
  FindScriptDocument(this: ScriptEditorService, script: LuaSourceContainer): ScriptDocument;
2740
+ GetEditorSource(this: ScriptEditorService, script: LuaSourceContainer): string;
2739
2741
  GetScriptDocuments(this: ScriptEditorService): Array<Instance>;
2740
- RegisterAutocompleteCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): null;
2741
- RegisterScriptAnalysisCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): null;
2742
+ RegisterAutocompleteCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
2743
+ RegisterScriptAnalysisCallback(this: ScriptEditorService, name: string, priority: number, callbackFunction: Callback): void;
2742
2744
  /**
2743
2745
  * Tags: Yields
2744
2746
  */
@@ -2775,7 +2777,7 @@ interface Selection extends Instance {
2775
2777
  * Tags: ReadOnly, NotReplicated
2776
2778
  */
2777
2779
  readonly SelectionThickness: number;
2778
- Add(this: Selection, instancesToAdd: Array<Instance>): null;
2780
+ Add(this: Selection, instancesToAdd: Array<Instance>): void;
2779
2781
  /**
2780
2782
  * Returns an array of currently selected [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s in Roblox Studio.
2781
2783
  *
@@ -2786,7 +2788,7 @@ interface Selection extends Instance {
2786
2788
  * For changing the current selection, please see [Selection:Set](https://developer.roblox.com/en-us/api-reference/function/Selection/Set).
2787
2789
  */
2788
2790
  Get(this: Selection): Array<Instance>;
2789
- Remove(this: Selection, instancesToRemove: Array<Instance>): null;
2791
+ Remove(this: Selection, instancesToRemove: Array<Instance>): void;
2790
2792
  /**
2791
2793
  * Sets the currently selected objects in Roblox Studio to [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s in the given array.
2792
2794
  *
@@ -2798,7 +2800,7 @@ interface Selection extends Instance {
2798
2800
  * table.insert(selected, object)
2799
2801
  * Selection:Set(selected)
2800
2802
  */
2801
- Set(this: Selection, selection: Array<Instance>): null;
2803
+ Set(this: Selection, selection: Array<Instance>): void;
2802
2804
  /**
2803
2805
  * Fires when the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)s selected in Roblox Studio changes.
2804
2806
  *
@@ -2889,13 +2891,13 @@ interface DataModel extends ServiceProvider<Services> {
2889
2891
  *
2890
2892
  * You can use [DataModel:SetUniverseId](https://developer.roblox.com/en-us/api-reference/function/DataModel/SetUniverseId) to set the [DataModel.GameId](https://developer.roblox.com/en-us/api-reference/property/DataModel/GameId) of the game instance. However, it is the [DataModel.PlaceId](https://developer.roblox.com/en-us/api-reference/property/DataModel/PlaceId) that must be set to access the [DataStoreService](https://developer.roblox.com/en-us/api-reference/class/DataStoreService).
2891
2893
  */
2892
- SetPlaceId(this: DataModel, placeId: number): null;
2894
+ SetPlaceId(this: DataModel, placeId: number): void;
2893
2895
  /**
2894
2896
  * This function sets the [DataModel.GameId](https://developer.roblox.com/en-us/api-reference/property/DataModel/GameId) of the current game instance to the given _universeId_. This is useful when testing local .rbxl files that have not been published to Roblox.
2895
2897
  *
2896
2898
  * If you want to access the [DataStoreService](https://developer.roblox.com/en-us/api-reference/class/DataStoreService) in an unpublished place, you should use [DataModel:SetPlaceId](https://developer.roblox.com/en-us/api-reference/function/DataModel/SetPlaceId) instead.
2897
2899
  */
2898
- SetUniverseId(this: DataModel, universeId: number): null;
2900
+ SetUniverseId(this: DataModel, universeId: number): void;
2899
2901
  }
2900
2902
 
2901
2903
  /** The base object used for Roblox Studio's settings menu.
@@ -3357,7 +3359,8 @@ interface StudioService extends Instance {
3357
3359
  */
3358
3360
  readonly DraggerSolveConstraints: boolean;
3359
3361
  /**
3360
- * Tags: ReadOnly, NotReplicated
3362
+ * Tags: ReadOnly, NotReplicated, Deprecated
3363
+ * @deprecated
3361
3364
  */
3362
3365
  readonly DrawConstraintsOnTop: boolean;
3363
3366
  /**
@@ -3639,7 +3642,7 @@ interface TerrainRegion extends Instance {
3639
3642
  * Tags: Deprecated
3640
3643
  * @deprecated
3641
3644
  */
3642
- ConvertToSmooth(this: TerrainRegion): null;
3645
+ ConvertToSmooth(this: TerrainRegion): void;
3643
3646
  }
3644
3647
 
3645
3648
  /** The TestService is a service used by Roblox internally to run analytical tests on their engine.
@@ -3886,44 +3889,44 @@ interface TestService extends Instance {
3886
3889
  /**
3887
3890
  * If condition is true, prints "Check passed: ", followed by description to the output, in blue text. Otherwise, prints "Check failed: ", again, followed by description, but in red text.
3888
3891
  */
3889
- Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): null;
3892
+ Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
3890
3893
  /**
3891
3894
  * Prints “Test checkpoint: ”, followed by text, to the output, in blue text.
3892
3895
  */
3893
- Checkpoint(this: TestService, text: string, source?: Instance, line?: number): null;
3896
+ Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
3894
3897
  /**
3895
3898
  * Prints Testing Done to the output, in blue text.
3896
3899
  */
3897
- Done(this: TestService): null;
3900
+ Done(this: TestService): void;
3898
3901
  /**
3899
3902
  * Prints a red message to the output, prefixed by `TestService:` .
3900
3903
  */
3901
- Error(this: TestService, description: string, source?: Instance, line?: number): null;
3904
+ Error(this: TestService, description: string, source?: Instance, line?: number): void;
3902
3905
  /**
3903
3906
  * Indicates a fatal error in a TestService run.
3904
3907
  *
3905
3908
  * If this is called inside of a script running inside of the TestService, this will initiate a [breakpoint](https://developer.roblox.com/articles/Lua-debugger "Lua Debugger") on the line that invoked the error.
3906
3909
  */
3907
- Fail(this: TestService, description: string, source?: Instance, line?: number): null;
3910
+ Fail(this: TestService, description: string, source?: Instance, line?: number): void;
3908
3911
  /**
3909
3912
  * Prints Test message, followed by text to the output, in blue text.
3910
3913
  */
3911
- Message(this: TestService, text: string, source?: Instance, line?: number): null;
3914
+ Message(this: TestService, text: string, source?: Instance, line?: number): void;
3912
3915
  /**
3913
3916
  * If `condition` is true, prints `Require passed:` , followed by `description`, to the output in blue text. Otherwise, prints `Require failed. Test ended:` , followed by `description`, to the output in red text.
3914
3917
  */
3915
- Require(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): null;
3918
+ Require(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
3916
3919
  ScopeTime(this: TestService): object;
3917
3920
  /**
3918
3921
  * If condition is true, prints Warning passed: , followed by description, to the output, in blue text. Otherwise, prints Warning: , followed by description, to the output, in yellow text.
3919
3922
  */
3920
- Warn(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): null;
3923
+ Warn(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
3921
3924
  isFeatureEnabled(this: TestService, name: string): boolean;
3922
3925
  /**
3923
3926
  * Runs scripts which are parented to TestService.
3924
3927
  * Tags: Yields
3925
3928
  */
3926
- Run(this: TestService): null;
3929
+ Run(this: TestService): void;
3927
3930
  /**
3928
3931
  * Fired when the server should collect a conditional test result.
3929
3932
  */
@@ -11641,9 +11641,25 @@ declare namespace Enum {
11641
11641
 
11642
11642
  export const Cylinder: Cylinder;
11643
11643
 
11644
+ export interface Wedge extends globalThis.EnumItem {
11645
+ Name: "Wedge";
11646
+ Value: 3;
11647
+ EnumType: typeof globalThis.Enum.PartType;
11648
+ }
11649
+
11650
+ export const Wedge: Wedge;
11651
+
11652
+ export interface CornerWedge extends globalThis.EnumItem {
11653
+ Name: "CornerWedge";
11654
+ Value: 4;
11655
+ EnumType: typeof globalThis.Enum.PartType;
11656
+ }
11657
+
11658
+ export const CornerWedge: CornerWedge;
11659
+
11644
11660
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PartType>;
11645
11661
  }
11646
- export type PartType = PartType.Ball | PartType.Block | PartType.Cylinder;
11662
+ export type PartType = PartType.Ball | PartType.Block | PartType.Cylinder | PartType.Wedge | PartType.CornerWedge;
11647
11663
 
11648
11664
  export namespace ParticleEmitterShape {
11649
11665
  export interface Box extends globalThis.EnumItem {
@@ -18692,6 +18708,35 @@ declare namespace Enum {
18692
18708
  }
18693
18709
  export type WaterForce = WaterForce.None | WaterForce.Small | WaterForce.Medium | WaterForce.Strong | WaterForce.Max;
18694
18710
 
18711
+ export namespace WeldConstraintPreserve {
18712
+ export interface All extends globalThis.EnumItem {
18713
+ Name: "All";
18714
+ Value: 0;
18715
+ EnumType: typeof globalThis.Enum.WeldConstraintPreserve;
18716
+ }
18717
+
18718
+ export const All: All;
18719
+
18720
+ export interface None extends globalThis.EnumItem {
18721
+ Name: "None";
18722
+ Value: 1;
18723
+ EnumType: typeof globalThis.Enum.WeldConstraintPreserve;
18724
+ }
18725
+
18726
+ export const None: None;
18727
+
18728
+ export interface Touching extends globalThis.EnumItem {
18729
+ Name: "Touching";
18730
+ Value: 2;
18731
+ EnumType: typeof globalThis.Enum.WeldConstraintPreserve;
18732
+ }
18733
+
18734
+ export const Touching: Touching;
18735
+
18736
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.WeldConstraintPreserve>;
18737
+ }
18738
+ export type WeldConstraintPreserve = WeldConstraintPreserve.All | WeldConstraintPreserve.None | WeldConstraintPreserve.Touching;
18739
+
18695
18740
  export namespace WrapLayerAutoSkin {
18696
18741
  export interface Disabled extends globalThis.EnumItem {
18697
18742
  Name: "Disabled";
@@ -2216,6 +2216,11 @@ declare function delay(delayTime: number, callback: DelayedCallback): void;
2216
2216
  * @deprecated use os.clock() instead.
2217
2217
  */
2218
2218
  declare function elapsedTime(): number;
2219
+ /**
2220
+ * Returns the total memory heap size in kilobytes.
2221
+ * The number reflects the current heap consumption from the operating system perspective, which fluctuates over time as garbage collector frees objects.
2222
+ */
2223
+ declare function gcinfo(): number;
2219
2224
  /** Runs the supplied ModuleScript if it has not been run already, and returns what the ModuleScript returned (in both cases).
2220
2225
 
2221
2226
  If the ModuleScript the user wants to use has been uploaded to Roblox (with the instance’s name being ‘MainModule’), it can be loaded by using the require function on the asset ID of the ModuleScript, though only on the server. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.679",
3
+ "version": "1.0.681",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },