@rbxts/types 1.0.880 → 1.0.881

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.
@@ -2422,6 +2422,12 @@ interface Instance extends RBXObject {
2422
2422
  * @returns True if the `Instance` is a descendant of the given ancestor.
2423
2423
  */
2424
2424
  IsDescendantOf(this: Instance, ancestor: Instance): boolean;
2425
+ /**
2426
+ * - **ThreadSafety**: Unsafe
2427
+ *
2428
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPredicted)
2429
+ */
2430
+ IsPredicted(this: Instance): boolean;
2425
2431
  /**
2426
2432
  * Returns `true` if the value stored in the specified property is equal to the code-instantiated default.
2427
2433
  *
@@ -2464,6 +2470,12 @@ interface Instance extends RBXObject {
2464
2470
  * @param value The value to set the specified attribute to.
2465
2471
  */
2466
2472
  SetAttribute(this: Instance, attribute: string, value: AttributeValue | undefined): void;
2473
+ /**
2474
+ * - **ThreadSafety**: Unsafe
2475
+ *
2476
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#SetPredictionMode)
2477
+ */
2478
+ SetPredictionMode(this: Instance, mode: CastsToEnum<Enum.PredictionMode>): void;
2467
2479
  /**
2468
2480
  * Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
2469
2481
  *
@@ -3159,11 +3171,11 @@ interface KeyframeSequence extends AnimationClip {
3159
3171
  *
3160
3172
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#GetKeyframes)
3161
3173
  * @param this This object stores all of the `Keyframes` and other data for the animation.
3162
- * @returns An array of `Keyframe`.
3174
+ * @returns An array of `Keyframes`.
3163
3175
  */
3164
3176
  GetKeyframes(this: KeyframeSequence): Array<Keyframe>;
3165
3177
  /**
3166
- * This function removes a `Keyframe` from the `KeyframeSequence` by setting its parent to `nil`.
3178
+ * This method removes a `Keyframe` from the `KeyframeSequence` by setting its parent to `nil`.
3167
3179
  *
3168
3180
  * - **ThreadSafety**: Unsafe
3169
3181
  *
@@ -6808,6 +6820,8 @@ interface AudioTextToSpeech extends Instance {
6808
6820
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
6809
6821
  }
6810
6822
  /**
6823
+ * Creates a trembling effect on a sound by varying the volume of the sound up and down.
6824
+ *
6811
6825
  * - **Tags**: NotBrowsable
6812
6826
  *
6813
6827
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
@@ -6828,36 +6842,48 @@ interface AudioTremolo extends Instance {
6828
6842
  */
6829
6843
  Bypass: boolean;
6830
6844
  /**
6845
+ * Controls how much the volume will raise and lower.
6846
+ *
6831
6847
  * - **ThreadSafety**: ReadSafe
6832
6848
  *
6833
6849
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Depth)
6834
6850
  */
6835
6851
  Depth: number;
6836
6852
  /**
6853
+ * Controls how long the effect will be active during one volume oscillation.
6854
+ *
6837
6855
  * - **ThreadSafety**: ReadSafe
6838
6856
  *
6839
6857
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Duty)
6840
6858
  */
6841
6859
  Duty: number;
6842
6860
  /**
6861
+ * Sets how often the effect will oscillate the volume.
6862
+ *
6843
6863
  * - **ThreadSafety**: ReadSafe
6844
6864
  *
6845
6865
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Frequency)
6846
6866
  */
6847
6867
  Frequency: number;
6848
6868
  /**
6869
+ * Controls the shape of the low frequency oscillations.
6870
+ *
6849
6871
  * - **ThreadSafety**: ReadSafe
6850
6872
  *
6851
6873
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Shape)
6852
6874
  */
6853
6875
  Shape: number;
6854
6876
  /**
6877
+ * Time-skews the low frequency oscillations cycle.
6878
+ *
6855
6879
  * - **ThreadSafety**: ReadSafe
6856
6880
  *
6857
6881
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Skew)
6858
6882
  */
6859
6883
  Skew: number;
6860
6884
  /**
6885
+ * Flatness of the low frequency oscillations shape.
6886
+ *
6861
6887
  * - **ThreadSafety**: ReadSafe
6862
6888
  *
6863
6889
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Square)
@@ -7051,9 +7077,9 @@ interface AuroraService extends Instance {
7051
7077
  /**
7052
7078
  * - **ThreadSafety**: Unsafe
7053
7079
  *
7054
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsPredicted)
7080
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
7055
7081
  */
7056
- IsPredicted(this: AuroraService, target: Instance): boolean;
7082
+ IsInstancePredicted(this: AuroraService, target: Instance): boolean;
7057
7083
  /**
7058
7084
  * - **ThreadSafety**: Unsafe
7059
7085
  *
@@ -7125,7 +7151,7 @@ interface AuroraService extends Instance {
7125
7151
  *
7126
7152
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Misprediction)
7127
7153
  */
7128
- readonly Misprediction: RBXScriptSignal<(worldStepId: number, mispredictedInstances: Array<unknown>) => void>;
7154
+ readonly Misprediction: RBXScriptSignal<(remoteWorldStepId: number, mispredictedInstances: Array<unknown>) => void>;
7129
7155
  /**
7130
7156
  * - **ThreadSafety**: Unsafe
7131
7157
  *
@@ -8592,7 +8618,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8592
8618
  */
8593
8619
  readonly _nominal_RemoteEvent: unique symbol;
8594
8620
  /**
8595
- * Fires the `OnClientEvent` event for each client connected to the same `RemoteEvent`.
8621
+ * Fires the `OnClientEvent` event for each connected client.
8596
8622
  *
8597
8623
  * - **ThreadSafety**: Unsafe
8598
8624
  *
@@ -8602,7 +8628,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8602
8628
  */
8603
8629
  FireAllClients(this: RemoteEvent, ...args: Parameters<T>): void;
8604
8630
  /**
8605
- * Fires the `OnClientEvent` event for a specific client connected to the same `RemoteEvent`.
8631
+ * Fires the `OnClientEvent` event for a specific client.
8606
8632
  *
8607
8633
  * - **ThreadSafety**: Unsafe
8608
8634
  *
@@ -8613,7 +8639,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8613
8639
  */
8614
8640
  FireClient(this: RemoteEvent, player: Player, ...args: Parameters<T>): void;
8615
8641
  /**
8616
- * Fires the `OnServerEvent` event on the server from one client connected to the same `RemoteEvent`.
8642
+ * Fires the `OnServerEvent` event on the server from one connected client.
8617
8643
  *
8618
8644
  * - **ThreadSafety**: Unsafe
8619
8645
  *
@@ -8654,7 +8680,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8654
8680
  */
8655
8681
  readonly _nominal_UnreliableRemoteEvent: unique symbol;
8656
8682
  /**
8657
- * Fires the `OnClientEvent` event for each client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
8683
+ * Fires the `OnClientEvent` event for all connected clients. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
8658
8684
  *
8659
8685
  * - **ThreadSafety**: Unsafe
8660
8686
  *
@@ -8664,7 +8690,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8664
8690
  */
8665
8691
  FireAllClients(this: UnreliableRemoteEvent, ...args: Parameters<T>): void;
8666
8692
  /**
8667
- * Fires the `OnClientEvent` event for a specific client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event. Otherwise, the event is dropped.
8693
+ * Fires the `OnClientEvent` event for a specific client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
8668
8694
  *
8669
8695
  * - **ThreadSafety**: Unsafe
8670
8696
  *
@@ -8675,7 +8701,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8675
8701
  */
8676
8702
  FireClient(this: UnreliableRemoteEvent, player: Player, ...args: Parameters<T>): void;
8677
8703
  /**
8678
- * Fires the `OnServerEvent` event on the server from one client connected to the same `UnreliableRemoteEvent`. Has a 1000 byte limit to the payload of the event, otherwise event is dropped.
8704
+ * Fires the `OnServerEvent` event on the server from one connected client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.
8679
8705
  *
8680
8706
  * - **ThreadSafety**: Unsafe
8681
8707
  *
@@ -9797,12 +9823,6 @@ interface CaptureService extends Instance {
9797
9823
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#GetDeviceInfo)
9798
9824
  */
9799
9825
  GetDeviceInfo(this: CaptureService): object;
9800
- /**
9801
- * - **ThreadSafety**: Unsafe
9802
- *
9803
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptCaptureGalleryPermission)
9804
- */
9805
- PromptCaptureGalleryPermission(this: CaptureService, captureGalleryPermission: CastsToEnum<Enum.CaptureGalleryPermission>, onAcceptedCallback: Callback, onDeniedCallback: Callback): void;
9806
9826
  /**
9807
9827
  * Prompts the user to save specified captures to their gallery.
9808
9828
  *
@@ -15455,6 +15475,20 @@ interface Decal extends FaceInstance {
15455
15475
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Color3)
15456
15476
  */
15457
15477
  Color3: Color3;
15478
+ /**
15479
+ * - **ThreadSafety**: ReadSafe
15480
+ * - **Tags**: NotReplicated
15481
+ *
15482
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMap)
15483
+ */
15484
+ ColorMap: ContentId;
15485
+ /**
15486
+ * - **ThreadSafety**: ReadSafe
15487
+ * - **Tags**: NotReplicated
15488
+ *
15489
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMapContent)
15490
+ */
15491
+ ColorMapContent: Content;
15458
15492
  /**
15459
15493
  * Acts as a multiplier for the decal's `Decal.Transparency` property. The effects are only visible to the local player.
15460
15494
  *
@@ -20536,7 +20570,7 @@ interface Path2D extends GuiBase {
20536
20570
  readonly ControlPointChanged: RBXScriptSignal<() => void>;
20537
20571
  }
20538
20572
  /**
20539
- * Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20573
+ * Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20540
20574
  *
20541
20575
  * - **Tags**: NotCreatable, Service, NotReplicated
20542
20576
  *
@@ -20552,7 +20586,7 @@ interface GuiService extends Instance {
20552
20586
  */
20553
20587
  readonly _nominal_GuiService: unique symbol;
20554
20588
  /**
20555
- * If activated, the `Select` button on a Gamepad or `Backslash` will automatically set a GUI as the selected object.
20589
+ * If activated, the `Select` button on a gamepad or `Backslash` will automatically set a GUI as the selected object.
20556
20590
  *
20557
20591
  * - **ThreadSafety**: ReadSafe
20558
20592
  *
@@ -20560,7 +20594,7 @@ interface GuiService extends Instance {
20560
20594
  */
20561
20595
  AutoSelectGuiEnabled: boolean;
20562
20596
  /**
20563
- * Toggles whether or not objects in the `CoreGui` can be navigated using a Gamepad.
20597
+ * Toggles whether or not objects in the `CoreGui` can be navigated using a gamepad.
20564
20598
  *
20565
20599
  * - **ThreadSafety**: ReadSafe
20566
20600
  * - **Tags**: Hidden, NotReplicated
@@ -20603,7 +20637,7 @@ interface GuiService extends Instance {
20603
20637
  */
20604
20638
  readonly IsWindows: boolean;
20605
20639
  /**
20606
- * Returns true if any menu of CoreGui is open.
20640
+ * Returns `true` if any menu of `CoreGui` is open.
20607
20641
  *
20608
20642
  * - **ThreadSafety**: ReadSafe
20609
20643
  * - **Tags**: NotReplicated
@@ -20612,6 +20646,8 @@ interface GuiService extends Instance {
20612
20646
  */
20613
20647
  readonly MenuIsOpen: boolean;
20614
20648
  /**
20649
+ * Gets the player's preferred text size as an `PreferredTextSize` value.
20650
+ *
20615
20651
  * - **ThreadSafety**: ReadSafe
20616
20652
  * - **Tags**: NotReplicated
20617
20653
  *
@@ -20619,7 +20655,7 @@ interface GuiService extends Instance {
20619
20655
  */
20620
20656
  readonly PreferredTextSize: Enum.PreferredTextSize;
20621
20657
  /**
20622
- * Gets the user's preferred transparency as a number between 0 and 1, which indicates how opaque they want the backgrounds of certain UI elements to be. The recommended usage is as a multiplier of an element's BackgroundTransparency. Defaults to 1.
20658
+ * Gets the player's preferred transparency as a number between `0` and `1`.
20623
20659
  *
20624
20660
  * - **ThreadSafety**: ReadSafe
20625
20661
  * - **Tags**: Hidden, NotReplicated
@@ -20628,7 +20664,7 @@ interface GuiService extends Instance {
20628
20664
  */
20629
20665
  readonly PreferredTransparency: number;
20630
20666
  /**
20631
- * Returns `true` if the user has enabled reduced motion. Defaults to `false`.
20667
+ * Returns `true` if the player has enabled reduced motion.
20632
20668
  *
20633
20669
  * - **ThreadSafety**: ReadSafe
20634
20670
  * - **Tags**: Hidden, NotReplicated
@@ -20637,7 +20673,7 @@ interface GuiService extends Instance {
20637
20673
  */
20638
20674
  readonly ReducedMotionEnabled: boolean;
20639
20675
  /**
20640
- * Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads).
20676
+ * Sets the `GuiObject` currently being focused on by the GUI navigator.
20641
20677
  *
20642
20678
  * - **ThreadSafety**: ReadSafe
20643
20679
  *
@@ -20654,7 +20690,7 @@ interface GuiService extends Instance {
20654
20690
  */
20655
20691
  readonly TopbarInset: Rect;
20656
20692
  /**
20657
- * Used to enable and disable touch controls and touch control display UI. Defaults to true.
20693
+ * Used to enable and disable touch controls and touch control display UI. Defaults to `true`.
20658
20694
  *
20659
20695
  * - **ThreadSafety**: ReadSafe
20660
20696
  *
@@ -20673,13 +20709,13 @@ interface GuiService extends Instance {
20673
20709
  /**
20674
20710
  * **Deprecated:**
20675
20711
  *
20676
- * Creates a gui selection group where gamepad gui navigation will only consider selectable gui objects that are within the group (children of selectionParent).
20712
+ * Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group.
20677
20713
  *
20678
20714
  * - **ThreadSafety**: Unsafe
20679
20715
  * - **Tags**:
20680
20716
  *
20681
20717
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionParent)
20682
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20718
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20683
20719
  * @param selectionName
20684
20720
  * @param selectionParent
20685
20721
  *
@@ -20698,7 +20734,7 @@ interface GuiService extends Instance {
20698
20734
  * - **Tags**:
20699
20735
  *
20700
20736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionTuple)
20701
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20737
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20702
20738
  * @param selectionName The name of the added selection.
20703
20739
  * @param selections The selection(s) added.
20704
20740
  *
@@ -20706,117 +20742,117 @@ interface GuiService extends Instance {
20706
20742
  */
20707
20743
  AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
20708
20744
  /**
20709
- * Closes the Inspect Menu, if open.
20745
+ * Closes the avatar inspection menu, if open.
20710
20746
  *
20711
20747
  * - **ThreadSafety**: Unsafe
20712
20748
  *
20713
20749
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#CloseInspectMenu)
20714
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20750
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20715
20751
  */
20716
20752
  CloseInspectMenu(this: GuiService): void;
20717
20753
  /**
20718
20754
  * - **ThreadSafety**: Unsafe
20719
20755
  *
20720
20756
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#DismissNotification)
20721
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20757
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20722
20758
  * @param notificationId
20723
20759
  */
20724
20760
  DismissNotification(this: GuiService, notificationId: string): boolean;
20725
20761
  /**
20726
- * Checks if the player Emotes menu is open.
20762
+ * Checks if the player emotes menu is open.
20727
20763
  *
20728
20764
  * - **ThreadSafety**: Unsafe
20729
20765
  *
20730
20766
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetEmotesMenuOpen)
20731
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20732
- * @returns Indicates whether the Emotes menu is open.
20767
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20768
+ * @returns Whether the emotes menu is open.
20733
20769
  */
20734
20770
  GetEmotesMenuOpen(this: GuiService): boolean;
20735
20771
  /**
20736
- * Returns whether or not the `gameplay paused` notification has been disabled by the developer.
20772
+ * Returns whether or not the `Player.GameplayPaused` notification has been disabled.
20737
20773
  *
20738
20774
  * - **ThreadSafety**: Unsafe
20739
20775
  *
20740
20776
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGameplayPausedNotificationEnabled)
20741
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20742
- * @returns Whether or not the `gameplay paused` notification has been disabled.
20777
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20778
+ * @returns Whether or not the `Player.GameplayPaused` notification has been disabled.
20743
20779
  */
20744
20780
  GetGameplayPausedNotificationEnabled(this: GuiService): boolean;
20745
20781
  /**
20746
- * Returns two `Vector2` values representing the inset of user GUIs in pixels, from the top left corner of the screen and the bottom right corner of the screen respectively.
20782
+ * Returns two `Vector2` values representing the inset of user GUIs in pixels, from the topleft corner of the screen and the bottomright corner of the screen respectively.
20747
20783
  *
20748
20784
  * - **ThreadSafety**: Unsafe
20749
20785
  *
20750
20786
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGuiInset)
20751
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20752
- * @returns A tuple of two Vector2 values describing the current specified Gui Inset.
20787
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20788
+ * @returns A tuple of two `Vector2` values describing the current specified GUI inset.
20753
20789
  */
20754
20790
  GetGuiInset(this: GuiService): LuaTuple<[
20755
20791
  Vector2,
20756
20792
  Vector2
20757
20793
  ]>;
20758
20794
  /**
20759
- * Returns whether the Inspect and Buy menu functionality is enabled.
20795
+ * Returns whether the avatar inspection menu is enabled.
20760
20796
  *
20761
20797
  * - **ThreadSafety**: Unsafe
20762
20798
  *
20763
20799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInspectMenuEnabled)
20764
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20765
- * @returns A boolean indicating whether the Inspect Menu feature is enabled.
20800
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20801
+ * @returns Whether the avatar inspection menu is enabled.
20766
20802
  */
20767
20803
  GetInspectMenuEnabled(this: GuiService): boolean;
20768
20804
  /**
20769
- * Allows a developer to bring up the Inspect menu showing the assets listed in this `HumanoidDescription` object.
20805
+ * Allows the avatar inspection menu to appear showing the assets listed in a `HumanoidDescription` object.
20770
20806
  *
20771
20807
  * - **ThreadSafety**: Unsafe
20772
20808
  *
20773
20809
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromHumanoidDescription)
20774
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20775
- * @param humanoidDescription A `HumanoidDescription` object that contains the assets to show in the Inspect menu.
20776
- * @param name The name of the player being Inspected to show in the Inspect menu.
20810
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20811
+ * @param humanoidDescription A `HumanoidDescription` object that contains the assets to show in the inspection menu.
20812
+ * @param name The name of the player being inspected to show in the menu.
20777
20813
  */
20778
20814
  InspectPlayerFromHumanoidDescription(this: GuiService, humanoidDescription: HumanoidDescription, name: string): void;
20779
20815
  /**
20780
- * Allows the Inspect Menu to appear showing the user that has the given `UserId`.
20816
+ * Allows the avatar inspection menu to appear showing the user that has the given `UserId`.
20781
20817
  *
20782
20818
  * - **ThreadSafety**: Unsafe
20783
20819
  *
20784
20820
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromUserId)
20785
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20821
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20786
20822
  * @param userId The `UserId` of the player to inspect.
20787
20823
  */
20788
20824
  InspectPlayerFromUserId(this: GuiService, userId: number): void;
20789
20825
  /**
20790
- * Returns true if the client is using the ten foot interface, which is a special version of Roblox's UI, exclusive to consoles. This is the only guaranteed way to verify if the user is on a console or not.
20826
+ * Returns `true` if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
20791
20827
  *
20792
20828
  * - **ThreadSafety**: Unsafe
20793
20829
  *
20794
20830
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#IsTenFootInterface)
20795
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20831
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20796
20832
  */
20797
20833
  IsTenFootInterface(this: GuiService): boolean;
20798
20834
  /**
20799
20835
  * **Deprecated:**
20800
20836
  *
20801
- * Removes a group that was created with `GuiService:AddSelectionParent()` or `GuiService:AddSelectionTuple()`.
20837
+ * Removes a group that was created with `AddSelectionParent()` or `AddSelectionTuple()`.
20802
20838
  *
20803
20839
  * - **ThreadSafety**: Unsafe
20804
20840
  * - **Tags**:
20805
20841
  *
20806
20842
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#RemoveSelectionGroup)
20807
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20843
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20808
20844
  * @param selectionName
20809
20845
  *
20810
20846
  * @deprecated SelectionGroup
20811
20847
  */
20812
20848
  RemoveSelectionGroup(this: GuiService, selectionName: string): void;
20813
20849
  /**
20814
- * Set GuiService.SelectedObject to a child of provided instance selectionParent that is PlayerGui or its descendants.
20850
+ * Sets `GuiService.SelectedObject` to a child of a provided instance that is the `PlayerGui` or its descendants.
20815
20851
  *
20816
20852
  * - **ThreadSafety**: Unsafe
20817
20853
  *
20818
20854
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#Select)
20819
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20855
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20820
20856
  * @param selectionParent The parent of selection whose descendants are searched.
20821
20857
  */
20822
20858
  Select(this: GuiService, selectionParent: Instance): void;
@@ -20824,42 +20860,42 @@ interface GuiService extends Instance {
20824
20860
  * - **ThreadSafety**: Unsafe
20825
20861
  *
20826
20862
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SendNotification)
20827
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20863
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20828
20864
  * @param notificationInfo
20829
20865
  */
20830
20866
  SendNotification(this: GuiService, notificationInfo: object): string;
20831
20867
  /**
20832
- * Opens or closes the player Emotes menu.
20868
+ * Opens or closes the player emotes menu.
20833
20869
  *
20834
20870
  * - **ThreadSafety**: Unsafe
20835
20871
  *
20836
20872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetEmotesMenuOpen)
20837
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20873
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20838
20874
  * @param isOpen
20839
20875
  */
20840
20876
  SetEmotesMenuOpen(this: GuiService, isOpen: boolean): void;
20841
20877
  /**
20842
- * Allows developers to disable the built-in notification when a players gameplay is paused.
20878
+ * Lets you disable the built-in notification when a player's gameplay is paused.
20843
20879
  *
20844
20880
  * - **ThreadSafety**: Unsafe
20845
20881
  *
20846
20882
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetGameplayPausedNotificationEnabled)
20847
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20883
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20848
20884
  * @param enabled Whether or not the built-in notification GUI is disabled.
20849
20885
  */
20850
20886
  SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean): void;
20851
20887
  /**
20852
- * Allows developers to enable or disable default Inspect and Buy functionality.
20888
+ * Allows you to enable or disable the avatar inspection menu.
20853
20889
  *
20854
20890
  * - **ThreadSafety**: Unsafe
20855
20891
  *
20856
20892
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetInspectMenuEnabled)
20857
- * @param this Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
20858
- * @param enabled A boolean indicating whether to enable or disable the Inspect Menu feature.
20893
+ * @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
20894
+ * @param enabled A boolean indicating whether to enable or disable the menu.
20859
20895
  */
20860
20896
  SetInspectMenuEnabled(this: GuiService, enabled: boolean): void;
20861
20897
  /**
20862
- * Fires when the user **closes** the Roblox coregui escape menu.
20898
+ * Fires when the user **closes** the Roblox `CoreGui` escape menu.
20863
20899
  *
20864
20900
  * - **ThreadSafety**: Unsafe
20865
20901
  *
@@ -20867,7 +20903,7 @@ interface GuiService extends Instance {
20867
20903
  */
20868
20904
  readonly MenuClosed: RBXScriptSignal<() => void>;
20869
20905
  /**
20870
- * Fires when the user **opens** the Roblox coregui escape menu.
20906
+ * Fires when the user **opens** the Roblox `CoreGui` escape menu.
20871
20907
  *
20872
20908
  * - **ThreadSafety**: Unsafe
20873
20909
  *
@@ -28652,8 +28688,6 @@ interface BasePart extends PVInstance {
28652
28688
  */
28653
28689
  GetRenderCFrame(this: BasePart): CFrame;
28654
28690
  /**
28655
- * **Deprecated:**
28656
- *
28657
28691
  * Returns the base part of an assembly of parts.
28658
28692
  *
28659
28693
  * - **ThreadSafety**: Safe
@@ -31102,6 +31136,7 @@ interface WorldRoot extends Model {
31102
31136
  * Returns an array of parts whose **bounding boxes** overlap a given box.
31103
31137
  *
31104
31138
  * - **ThreadSafety**: Safe
31139
+ * - **Tags**: CustomLuaState
31105
31140
  *
31106
31141
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInBox)
31107
31142
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31115,6 +31150,7 @@ interface WorldRoot extends Model {
31115
31150
  * Returns an array of parts whose **bounding boxes** overlap a given sphere.
31116
31151
  *
31117
31152
  * - **ThreadSafety**: Safe
31153
+ * - **Tags**: CustomLuaState
31118
31154
  *
31119
31155
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInRadius)
31120
31156
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31128,6 +31164,7 @@ interface WorldRoot extends Model {
31128
31164
  * Returns an array of parts whose occupied space is shared with the given part.
31129
31165
  *
31130
31166
  * - **ThreadSafety**: Safe
31167
+ * - **Tags**: CustomLuaState
31131
31168
  *
31132
31169
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartsInPart)
31133
31170
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31233,6 +31270,8 @@ interface Workspace extends WorldRoot {
31233
31270
  */
31234
31271
  AirDensity: number;
31235
31272
  /**
31273
+ * Controls the strength of turbulence present in the wind velocity field, affecting the aerodynamic force model.
31274
+ *
31236
31275
  * - **ThreadSafety**: ReadSafe
31237
31276
  *
31238
31277
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirTurbulenceIntensity)
@@ -31247,6 +31286,12 @@ interface Workspace extends WorldRoot {
31247
31286
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales)
31248
31287
  */
31249
31288
  AllowThirdPartySales: boolean;
31289
+ /**
31290
+ * - **ThreadSafety**: ReadSafe
31291
+ *
31292
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AuthorityMode)
31293
+ */
31294
+ AuthorityMode: Enum.AuthorityMode;
31250
31295
  /**
31251
31296
  * Specifies the animation throttling mode for the local client.
31252
31297
  *
@@ -35134,6 +35179,13 @@ interface RecommendationService extends Instance {
35134
35179
  * @param generateRecommendationItemListRequest
35135
35180
  */
35136
35181
  GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
35182
+ /**
35183
+ * - **ThreadSafety**: Unsafe
35184
+ * - **Tags**: Yields
35185
+ *
35186
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GetRecommendationItemAsync)
35187
+ */
35188
+ GetRecommendationItemAsync(this: RecommendationService, itemId: string): object;
35137
35189
  /**
35138
35190
  * - **ThreadSafety**: Unsafe
35139
35191
  * - **Tags**: Yields
@@ -35616,6 +35668,13 @@ interface RunService extends Instance {
35616
35668
  * @deprecated
35617
35669
  */
35618
35670
  readonly _nominal_RunService: unique symbol;
35671
+ /**
35672
+ * - **ThreadSafety**: ReadSafe
35673
+ * - **Tags**: NotReplicated
35674
+ *
35675
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#ServerFrame)
35676
+ */
35677
+ readonly ServerFrame: number;
35619
35678
  /**
35620
35679
  * Given a string name of a function and a priority, this method binds the function to `RunService.PreRender`.
35621
35680
  *
@@ -35688,6 +35747,12 @@ interface RunService extends Instance {
35688
35747
  * @param name The name of the function being unbound.
35689
35748
  */
35690
35749
  UnbindFromRenderStep(this: RunService, name: string): void;
35750
+ /**
35751
+ * - **ThreadSafety**: Unsafe
35752
+ *
35753
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#FixedHeartbeat)
35754
+ */
35755
+ readonly FixedHeartbeat: RBXScriptSignal<(deltaTime: number) => void>;
35691
35756
  /**
35692
35757
  * Fires every frame, after the physics simulation has completed.
35693
35758
  *
@@ -41544,6 +41609,8 @@ interface TextFilterTranslatedResult extends Instance {
41544
41609
  GetTranslations(this: TextFilterTranslatedResult): object;
41545
41610
  }
41546
41611
  /**
41612
+ * Gives access to a large language model for text generation.
41613
+ *
41547
41614
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
41548
41615
  */
41549
41616
  interface TextGenerator extends Instance {
@@ -41556,16 +41623,47 @@ interface TextGenerator extends Instance {
41556
41623
  */
41557
41624
  readonly _nominal_TextGenerator: unique symbol;
41558
41625
  /**
41626
+ * Sets a fixed seed for the random number generator, allowing reproducible responses in cases where the same input parameters are used across multiple requests.
41627
+ *
41628
+ * - **ThreadSafety**: ReadSafe
41629
+ *
41630
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Seed)
41631
+ */
41632
+ Seed: number;
41633
+ /**
41634
+ * Provides context to the model about its role, tone, or behavior during conversation.
41635
+ *
41559
41636
  * - **ThreadSafety**: ReadSafe
41560
41637
  *
41561
41638
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#SystemPrompt)
41562
41639
  */
41563
41640
  SystemPrompt: string;
41564
41641
  /**
41642
+ * Controls the "creativity" or randomness of the model's responses.
41643
+ *
41644
+ * - **ThreadSafety**: ReadSafe
41645
+ *
41646
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Temperature)
41647
+ */
41648
+ Temperature: number;
41649
+ /**
41650
+ * Helps the AI model narrow or expand the range of possible words to sample from while generating the next token.
41651
+ *
41652
+ * - **ThreadSafety**: ReadSafe
41653
+ *
41654
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#TopP)
41655
+ */
41656
+ TopP: number;
41657
+ /**
41658
+ * Returns text generated by an LLM based on the provided system and user prompts.
41659
+ *
41565
41660
  * - **ThreadSafety**: Unsafe
41566
41661
  * - **Tags**: Yields
41567
41662
  *
41568
41663
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#GenerateTextAsync)
41664
+ * @param this Gives access to a large language model for text generation.
41665
+ * @param request A dictionary containing optional parameters for the text generation request. The currently supported parameters are `UserPrompt`, `ContextToken`, and `MaxTokens`.
41666
+ * @returns A dictionary containing the LLM's generated response.
41569
41667
  */
41570
41668
  GenerateTextAsync(this: TextGenerator, request: object): object;
41571
41669
  }
@@ -45122,12 +45220,6 @@ interface VideoPlayer extends Instance {
45122
45220
  * @deprecated
45123
45221
  */
45124
45222
  readonly _nominal_VideoPlayer: unique symbol;
45125
- /**
45126
- * - **ThreadSafety**: ReadSafe
45127
- *
45128
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Asset)
45129
- */
45130
- Asset: ContentId;
45131
45223
  /**
45132
45224
  * - **ThreadSafety**: ReadSafe
45133
45225
  * - **Tags**: NotReplicated
@@ -1913,6 +1913,8 @@ interface AudioTextToSpeech extends Instance {
1913
1913
  readonly _nominal_AudioTextToSpeech: unique symbol;
1914
1914
  }
1915
1915
  /**
1916
+ * Creates a trembling effect on a sound by varying the volume of the sound up and down.
1917
+ *
1916
1918
  * - **Tags**: NotBrowsable
1917
1919
  *
1918
1920
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
@@ -6611,7 +6613,7 @@ interface Path2D extends GuiBase {
6611
6613
  readonly _nominal_Path2D: unique symbol;
6612
6614
  }
6613
6615
  /**
6614
- * Allows developers to control what `GuiObject` is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.
6616
+ * Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
6615
6617
  *
6616
6618
  * - **Tags**: NotCreatable, Service, NotReplicated
6617
6619
  *
@@ -13944,6 +13946,8 @@ interface TextFilterTranslatedResult extends Instance {
13944
13946
  readonly _nominal_TextFilterTranslatedResult: unique symbol;
13945
13947
  }
13946
13948
  /**
13949
+ * Gives access to a large language model for text generation.
13950
+ *
13947
13951
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
13948
13952
  */
13949
13953
  interface TextGenerator extends Instance {
@@ -23275,28 +23275,28 @@ declare namespace Enum {
23275
23275
  }
23276
23276
  export const Auto: Auto;
23277
23277
  /**
23278
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#None)
23278
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#On)
23279
23279
  */
23280
- export interface None extends globalThis.EnumItem {
23281
- Name: "None";
23280
+ export interface On extends globalThis.EnumItem {
23281
+ Name: "On";
23282
23282
  Value: 1;
23283
23283
  EnumType: typeof globalThis.Enum.PredictionMode;
23284
23284
  }
23285
- export const None: None;
23285
+ export const On: On;
23286
23286
  /**
23287
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Forced)
23287
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Off)
23288
23288
  */
23289
- export interface Forced extends globalThis.EnumItem {
23290
- Name: "Forced";
23289
+ export interface Off extends globalThis.EnumItem {
23290
+ Name: "Off";
23291
23291
  Value: 2;
23292
23292
  EnumType: typeof globalThis.Enum.PredictionMode;
23293
23293
  }
23294
- export const Forced: Forced;
23294
+ export const Off: Off;
23295
23295
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PredictionMode>;
23296
23296
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PredictionMode | undefined;
23297
23297
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PredictionMode | undefined;
23298
23298
  }
23299
- export type PredictionMode = PredictionMode.Auto | PredictionMode.None | PredictionMode.Forced;
23299
+ export type PredictionMode = PredictionMode.Auto | PredictionMode.On | PredictionMode.Off;
23300
23300
  /**
23301
23301
  * This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
23302
23302
  *
@@ -23342,10 +23342,14 @@ declare namespace Enum {
23342
23342
  }
23343
23343
  export type PreferredInput = PreferredInput.KeyboardAndMouse | PreferredInput.Gamepad | PreferredInput.Touch;
23344
23344
  /**
23345
+ * This enum is used with `GuiService.PreferredTextSize` to indicate the player's preferred text size.
23346
+ *
23345
23347
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize)
23346
23348
  */
23347
23349
  export namespace PreferredTextSize {
23348
23350
  /**
23351
+ * The player prefers default text size.
23352
+ *
23349
23353
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Medium)
23350
23354
  */
23351
23355
  export interface Medium extends globalThis.EnumItem {
@@ -23355,6 +23359,8 @@ declare namespace Enum {
23355
23359
  }
23356
23360
  export const Medium: Medium;
23357
23361
  /**
23362
+ * The player prefers text size slightly increased beyond default.
23363
+ *
23358
23364
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Large)
23359
23365
  */
23360
23366
  export interface Large extends globalThis.EnumItem {
@@ -23364,6 +23370,8 @@ declare namespace Enum {
23364
23370
  }
23365
23371
  export const Large: Large;
23366
23372
  /**
23373
+ * The player prefers text size moderately increased beyond default.
23374
+ *
23367
23375
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Larger)
23368
23376
  */
23369
23377
  export interface Larger extends globalThis.EnumItem {
@@ -23373,6 +23381,8 @@ declare namespace Enum {
23373
23381
  }
23374
23382
  export const Larger: Larger;
23375
23383
  /**
23384
+ * The player prefers text size considerably increased beyond default.
23385
+ *
23376
23386
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Largest)
23377
23387
  */
23378
23388
  export interface Largest extends globalThis.EnumItem {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.880",
3
+ "version": "1.0.881",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },