@rbxts/types 1.0.879 → 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.
@@ -273,6 +273,7 @@ interface CreatableInstances {
273
273
  AudioSearchParams: AudioSearchParams;
274
274
  AudioSpeechToText: AudioSpeechToText;
275
275
  AudioTextToSpeech: AudioTextToSpeech;
276
+ AudioTremolo: AudioTremolo;
276
277
  AuroraScript: AuroraScript;
277
278
  AvatarAccessoryRules: AvatarAccessoryRules;
278
279
  AvatarAnimationRules: AvatarAnimationRules;
@@ -2421,6 +2422,12 @@ interface Instance extends RBXObject {
2421
2422
  * @returns True if the `Instance` is a descendant of the given ancestor.
2422
2423
  */
2423
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;
2424
2431
  /**
2425
2432
  * Returns `true` if the value stored in the specified property is equal to the code-instantiated default.
2426
2433
  *
@@ -2463,6 +2470,12 @@ interface Instance extends RBXObject {
2463
2470
  * @param value The value to set the specified attribute to.
2464
2471
  */
2465
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;
2466
2479
  /**
2467
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.
2468
2481
  *
@@ -3158,11 +3171,11 @@ interface KeyframeSequence extends AnimationClip {
3158
3171
  *
3159
3172
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#GetKeyframes)
3160
3173
  * @param this This object stores all of the `Keyframes` and other data for the animation.
3161
- * @returns An array of `Keyframe`.
3174
+ * @returns An array of `Keyframes`.
3162
3175
  */
3163
3176
  GetKeyframes(this: KeyframeSequence): Array<Keyframe>;
3164
3177
  /**
3165
- * 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`.
3166
3179
  *
3167
3180
  * - **ThreadSafety**: Unsafe
3168
3181
  *
@@ -6806,6 +6819,101 @@ interface AudioTextToSpeech extends Instance {
6806
6819
  */
6807
6820
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
6808
6821
  }
6822
+ /**
6823
+ * Creates a trembling effect on a sound by varying the volume of the sound up and down.
6824
+ *
6825
+ * - **Tags**: NotBrowsable
6826
+ *
6827
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
6828
+ */
6829
+ interface AudioTremolo extends Instance {
6830
+ /**
6831
+ * **DO NOT USE!**
6832
+ *
6833
+ * This field exists to force TypeScript to recognize this as a nominal type
6834
+ * @hidden
6835
+ * @deprecated
6836
+ */
6837
+ readonly _nominal_AudioTremolo: unique symbol;
6838
+ /**
6839
+ * - **ThreadSafety**: ReadSafe
6840
+ *
6841
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Bypass)
6842
+ */
6843
+ Bypass: boolean;
6844
+ /**
6845
+ * Controls how much the volume will raise and lower.
6846
+ *
6847
+ * - **ThreadSafety**: ReadSafe
6848
+ *
6849
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Depth)
6850
+ */
6851
+ Depth: number;
6852
+ /**
6853
+ * Controls how long the effect will be active during one volume oscillation.
6854
+ *
6855
+ * - **ThreadSafety**: ReadSafe
6856
+ *
6857
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Duty)
6858
+ */
6859
+ Duty: number;
6860
+ /**
6861
+ * Sets how often the effect will oscillate the volume.
6862
+ *
6863
+ * - **ThreadSafety**: ReadSafe
6864
+ *
6865
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Frequency)
6866
+ */
6867
+ Frequency: number;
6868
+ /**
6869
+ * Controls the shape of the low frequency oscillations.
6870
+ *
6871
+ * - **ThreadSafety**: ReadSafe
6872
+ *
6873
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Shape)
6874
+ */
6875
+ Shape: number;
6876
+ /**
6877
+ * Time-skews the low frequency oscillations cycle.
6878
+ *
6879
+ * - **ThreadSafety**: ReadSafe
6880
+ *
6881
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Skew)
6882
+ */
6883
+ Skew: number;
6884
+ /**
6885
+ * Flatness of the low frequency oscillations shape.
6886
+ *
6887
+ * - **ThreadSafety**: ReadSafe
6888
+ *
6889
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Square)
6890
+ */
6891
+ Square: number;
6892
+ /**
6893
+ * - **ThreadSafety**: Unsafe
6894
+ *
6895
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
6896
+ */
6897
+ GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
6898
+ /**
6899
+ * - **ThreadSafety**: Unsafe
6900
+ *
6901
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
6902
+ */
6903
+ GetInputPins(this: AudioTremolo): Array<unknown>;
6904
+ /**
6905
+ * - **ThreadSafety**: Unsafe
6906
+ *
6907
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
6908
+ */
6909
+ GetOutputPins(this: AudioTremolo): Array<unknown>;
6910
+ /**
6911
+ * - **ThreadSafety**: Unsafe
6912
+ *
6913
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#WiringChanged)
6914
+ */
6915
+ readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
6916
+ }
6809
6917
  /**
6810
6918
  * - **Tags**: NotCreatable
6811
6919
  *
@@ -6857,6 +6965,20 @@ interface AuroraScriptService extends Instance {
6857
6965
  * @deprecated
6858
6966
  */
6859
6967
  readonly _nominal_AuroraScriptService: unique symbol;
6968
+ /**
6969
+ * - **ThreadSafety**: Safe
6970
+ * - **Tags**: CustomLuaState
6971
+ *
6972
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
6973
+ */
6974
+ FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
6975
+ /**
6976
+ * - **ThreadSafety**: Safe
6977
+ * - **Tags**: CustomLuaState
6978
+ *
6979
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
6980
+ */
6981
+ FindBindings(this: AuroraScriptService, instance: Instance): object;
6860
6982
  /**
6861
6983
  * - **ThreadSafety**: Safe
6862
6984
  *
@@ -6955,9 +7077,9 @@ interface AuroraService extends Instance {
6955
7077
  /**
6956
7078
  * - **ThreadSafety**: Unsafe
6957
7079
  *
6958
- * [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)
6959
7081
  */
6960
- IsPredicted(this: AuroraService, target: Instance): boolean;
7082
+ IsInstancePredicted(this: AuroraService, target: Instance): boolean;
6961
7083
  /**
6962
7084
  * - **ThreadSafety**: Unsafe
6963
7085
  *
@@ -7029,7 +7151,7 @@ interface AuroraService extends Instance {
7029
7151
  *
7030
7152
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Misprediction)
7031
7153
  */
7032
- readonly Misprediction: RBXScriptSignal<(worldStepId: number, mispredictedInstances: Array<unknown>) => void>;
7154
+ readonly Misprediction: RBXScriptSignal<(remoteWorldStepId: number, mispredictedInstances: Array<unknown>) => void>;
7033
7155
  /**
7034
7156
  * - **ThreadSafety**: Unsafe
7035
7157
  *
@@ -8496,7 +8618,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8496
8618
  */
8497
8619
  readonly _nominal_RemoteEvent: unique symbol;
8498
8620
  /**
8499
- * Fires the `OnClientEvent` event for each client connected to the same `RemoteEvent`.
8621
+ * Fires the `OnClientEvent` event for each connected client.
8500
8622
  *
8501
8623
  * - **ThreadSafety**: Unsafe
8502
8624
  *
@@ -8506,7 +8628,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8506
8628
  */
8507
8629
  FireAllClients(this: RemoteEvent, ...args: Parameters<T>): void;
8508
8630
  /**
8509
- * Fires the `OnClientEvent` event for a specific client connected to the same `RemoteEvent`.
8631
+ * Fires the `OnClientEvent` event for a specific client.
8510
8632
  *
8511
8633
  * - **ThreadSafety**: Unsafe
8512
8634
  *
@@ -8517,7 +8639,7 @@ interface RemoteEvent<T extends Callback = Callback> extends BaseRemoteEvent {
8517
8639
  */
8518
8640
  FireClient(this: RemoteEvent, player: Player, ...args: Parameters<T>): void;
8519
8641
  /**
8520
- * 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.
8521
8643
  *
8522
8644
  * - **ThreadSafety**: Unsafe
8523
8645
  *
@@ -8558,7 +8680,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8558
8680
  */
8559
8681
  readonly _nominal_UnreliableRemoteEvent: unique symbol;
8560
8682
  /**
8561
- * 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.
8562
8684
  *
8563
8685
  * - **ThreadSafety**: Unsafe
8564
8686
  *
@@ -8568,7 +8690,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8568
8690
  */
8569
8691
  FireAllClients(this: UnreliableRemoteEvent, ...args: Parameters<T>): void;
8570
8692
  /**
8571
- * 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.
8572
8694
  *
8573
8695
  * - **ThreadSafety**: Unsafe
8574
8696
  *
@@ -8579,7 +8701,7 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
8579
8701
  */
8580
8702
  FireClient(this: UnreliableRemoteEvent, player: Player, ...args: Parameters<T>): void;
8581
8703
  /**
8582
- * 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.
8583
8705
  *
8584
8706
  * - **ThreadSafety**: Unsafe
8585
8707
  *
@@ -9701,12 +9823,6 @@ interface CaptureService extends Instance {
9701
9823
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#GetDeviceInfo)
9702
9824
  */
9703
9825
  GetDeviceInfo(this: CaptureService): object;
9704
- /**
9705
- * - **ThreadSafety**: Unsafe
9706
- *
9707
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptCaptureGalleryPermission)
9708
- */
9709
- PromptCaptureGalleryPermission(this: CaptureService, captureGalleryPermission: CastsToEnum<Enum.CaptureGalleryPermission>, onAcceptedCallback: Callback, onDeniedCallback: Callback): void;
9710
9826
  /**
9711
9827
  * Prompts the user to save specified captures to their gallery.
9712
9828
  *
@@ -10300,6 +10416,8 @@ interface ClickDetector extends Instance {
10300
10416
  */
10301
10417
  CursorIcon: ContentId;
10302
10418
  /**
10419
+ * Sets the cursor icon to display when the mouse is hovered over the parent of this `ClickDetector` or `DragDetector`. Only supports asset URIs.
10420
+ *
10303
10421
  * - **ThreadSafety**: ReadSafe
10304
10422
  *
10305
10423
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIconContent)
@@ -10369,6 +10487,8 @@ interface DragDetector extends ClickDetector {
10369
10487
  */
10370
10488
  ActivatedCursorIcon: ContentId;
10371
10489
  /**
10490
+ * Sets the cursor icon to display when the mouse is activated over the parent of this `DragDetector`. Only supports asset URIs
10491
+ *
10372
10492
  * - **ThreadSafety**: ReadSafe
10373
10493
  *
10374
10494
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIconContent)
@@ -15355,6 +15475,20 @@ interface Decal extends FaceInstance {
15355
15475
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Color3)
15356
15476
  */
15357
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;
15358
15492
  /**
15359
15493
  * Acts as a multiplier for the decal's `Decal.Transparency` property. The effects are only visible to the local player.
15360
15494
  *
@@ -20436,7 +20570,7 @@ interface Path2D extends GuiBase {
20436
20570
  readonly ControlPointChanged: RBXScriptSignal<() => void>;
20437
20571
  }
20438
20572
  /**
20439
- * 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.
20440
20574
  *
20441
20575
  * - **Tags**: NotCreatable, Service, NotReplicated
20442
20576
  *
@@ -20452,7 +20586,7 @@ interface GuiService extends Instance {
20452
20586
  */
20453
20587
  readonly _nominal_GuiService: unique symbol;
20454
20588
  /**
20455
- * 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.
20456
20590
  *
20457
20591
  * - **ThreadSafety**: ReadSafe
20458
20592
  *
@@ -20460,7 +20594,7 @@ interface GuiService extends Instance {
20460
20594
  */
20461
20595
  AutoSelectGuiEnabled: boolean;
20462
20596
  /**
20463
- * 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.
20464
20598
  *
20465
20599
  * - **ThreadSafety**: ReadSafe
20466
20600
  * - **Tags**: Hidden, NotReplicated
@@ -20503,7 +20637,7 @@ interface GuiService extends Instance {
20503
20637
  */
20504
20638
  readonly IsWindows: boolean;
20505
20639
  /**
20506
- * Returns true if any menu of CoreGui is open.
20640
+ * Returns `true` if any menu of `CoreGui` is open.
20507
20641
  *
20508
20642
  * - **ThreadSafety**: ReadSafe
20509
20643
  * - **Tags**: NotReplicated
@@ -20512,6 +20646,8 @@ interface GuiService extends Instance {
20512
20646
  */
20513
20647
  readonly MenuIsOpen: boolean;
20514
20648
  /**
20649
+ * Gets the player's preferred text size as an `PreferredTextSize` value.
20650
+ *
20515
20651
  * - **ThreadSafety**: ReadSafe
20516
20652
  * - **Tags**: NotReplicated
20517
20653
  *
@@ -20519,7 +20655,7 @@ interface GuiService extends Instance {
20519
20655
  */
20520
20656
  readonly PreferredTextSize: Enum.PreferredTextSize;
20521
20657
  /**
20522
- * 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`.
20523
20659
  *
20524
20660
  * - **ThreadSafety**: ReadSafe
20525
20661
  * - **Tags**: Hidden, NotReplicated
@@ -20528,7 +20664,7 @@ interface GuiService extends Instance {
20528
20664
  */
20529
20665
  readonly PreferredTransparency: number;
20530
20666
  /**
20531
- * Returns `true` if the user has enabled reduced motion. Defaults to `false`.
20667
+ * Returns `true` if the player has enabled reduced motion.
20532
20668
  *
20533
20669
  * - **ThreadSafety**: ReadSafe
20534
20670
  * - **Tags**: Hidden, NotReplicated
@@ -20537,7 +20673,7 @@ interface GuiService extends Instance {
20537
20673
  */
20538
20674
  readonly ReducedMotionEnabled: boolean;
20539
20675
  /**
20540
- * 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.
20541
20677
  *
20542
20678
  * - **ThreadSafety**: ReadSafe
20543
20679
  *
@@ -20554,7 +20690,7 @@ interface GuiService extends Instance {
20554
20690
  */
20555
20691
  readonly TopbarInset: Rect;
20556
20692
  /**
20557
- * 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`.
20558
20694
  *
20559
20695
  * - **ThreadSafety**: ReadSafe
20560
20696
  *
@@ -20573,13 +20709,13 @@ interface GuiService extends Instance {
20573
20709
  /**
20574
20710
  * **Deprecated:**
20575
20711
  *
20576
- * 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.
20577
20713
  *
20578
20714
  * - **ThreadSafety**: Unsafe
20579
20715
  * - **Tags**:
20580
20716
  *
20581
20717
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionParent)
20582
- * @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.
20583
20719
  * @param selectionName
20584
20720
  * @param selectionParent
20585
20721
  *
@@ -20598,7 +20734,7 @@ interface GuiService extends Instance {
20598
20734
  * - **Tags**:
20599
20735
  *
20600
20736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionTuple)
20601
- * @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.
20602
20738
  * @param selectionName The name of the added selection.
20603
20739
  * @param selections The selection(s) added.
20604
20740
  *
@@ -20606,117 +20742,117 @@ interface GuiService extends Instance {
20606
20742
  */
20607
20743
  AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
20608
20744
  /**
20609
- * Closes the Inspect Menu, if open.
20745
+ * Closes the avatar inspection menu, if open.
20610
20746
  *
20611
20747
  * - **ThreadSafety**: Unsafe
20612
20748
  *
20613
20749
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#CloseInspectMenu)
20614
- * @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.
20615
20751
  */
20616
20752
  CloseInspectMenu(this: GuiService): void;
20617
20753
  /**
20618
20754
  * - **ThreadSafety**: Unsafe
20619
20755
  *
20620
20756
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#DismissNotification)
20621
- * @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.
20622
20758
  * @param notificationId
20623
20759
  */
20624
20760
  DismissNotification(this: GuiService, notificationId: string): boolean;
20625
20761
  /**
20626
- * Checks if the player Emotes menu is open.
20762
+ * Checks if the player emotes menu is open.
20627
20763
  *
20628
20764
  * - **ThreadSafety**: Unsafe
20629
20765
  *
20630
20766
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetEmotesMenuOpen)
20631
- * @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.
20632
- * @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.
20633
20769
  */
20634
20770
  GetEmotesMenuOpen(this: GuiService): boolean;
20635
20771
  /**
20636
- * 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.
20637
20773
  *
20638
20774
  * - **ThreadSafety**: Unsafe
20639
20775
  *
20640
20776
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGameplayPausedNotificationEnabled)
20641
- * @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.
20642
- * @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.
20643
20779
  */
20644
20780
  GetGameplayPausedNotificationEnabled(this: GuiService): boolean;
20645
20781
  /**
20646
- * 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.
20647
20783
  *
20648
20784
  * - **ThreadSafety**: Unsafe
20649
20785
  *
20650
20786
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGuiInset)
20651
- * @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.
20652
- * @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.
20653
20789
  */
20654
20790
  GetGuiInset(this: GuiService): LuaTuple<[
20655
20791
  Vector2,
20656
20792
  Vector2
20657
20793
  ]>;
20658
20794
  /**
20659
- * Returns whether the Inspect and Buy menu functionality is enabled.
20795
+ * Returns whether the avatar inspection menu is enabled.
20660
20796
  *
20661
20797
  * - **ThreadSafety**: Unsafe
20662
20798
  *
20663
20799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInspectMenuEnabled)
20664
- * @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.
20665
- * @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.
20666
20802
  */
20667
20803
  GetInspectMenuEnabled(this: GuiService): boolean;
20668
20804
  /**
20669
- * 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.
20670
20806
  *
20671
20807
  * - **ThreadSafety**: Unsafe
20672
20808
  *
20673
20809
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromHumanoidDescription)
20674
- * @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.
20675
- * @param humanoidDescription A `HumanoidDescription` object that contains the assets to show in the Inspect menu.
20676
- * @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.
20677
20813
  */
20678
20814
  InspectPlayerFromHumanoidDescription(this: GuiService, humanoidDescription: HumanoidDescription, name: string): void;
20679
20815
  /**
20680
- * 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`.
20681
20817
  *
20682
20818
  * - **ThreadSafety**: Unsafe
20683
20819
  *
20684
20820
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromUserId)
20685
- * @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.
20686
20822
  * @param userId The `UserId` of the player to inspect.
20687
20823
  */
20688
20824
  InspectPlayerFromUserId(this: GuiService, userId: number): void;
20689
20825
  /**
20690
- * 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.
20691
20827
  *
20692
20828
  * - **ThreadSafety**: Unsafe
20693
20829
  *
20694
20830
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#IsTenFootInterface)
20695
- * @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.
20696
20832
  */
20697
20833
  IsTenFootInterface(this: GuiService): boolean;
20698
20834
  /**
20699
20835
  * **Deprecated:**
20700
20836
  *
20701
- * Removes a group that was created with `GuiService:AddSelectionParent()` or `GuiService:AddSelectionTuple()`.
20837
+ * Removes a group that was created with `AddSelectionParent()` or `AddSelectionTuple()`.
20702
20838
  *
20703
20839
  * - **ThreadSafety**: Unsafe
20704
20840
  * - **Tags**:
20705
20841
  *
20706
20842
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#RemoveSelectionGroup)
20707
- * @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.
20708
20844
  * @param selectionName
20709
20845
  *
20710
20846
  * @deprecated SelectionGroup
20711
20847
  */
20712
20848
  RemoveSelectionGroup(this: GuiService, selectionName: string): void;
20713
20849
  /**
20714
- * 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.
20715
20851
  *
20716
20852
  * - **ThreadSafety**: Unsafe
20717
20853
  *
20718
20854
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#Select)
20719
- * @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.
20720
20856
  * @param selectionParent The parent of selection whose descendants are searched.
20721
20857
  */
20722
20858
  Select(this: GuiService, selectionParent: Instance): void;
@@ -20724,42 +20860,42 @@ interface GuiService extends Instance {
20724
20860
  * - **ThreadSafety**: Unsafe
20725
20861
  *
20726
20862
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SendNotification)
20727
- * @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.
20728
20864
  * @param notificationInfo
20729
20865
  */
20730
20866
  SendNotification(this: GuiService, notificationInfo: object): string;
20731
20867
  /**
20732
- * Opens or closes the player Emotes menu.
20868
+ * Opens or closes the player emotes menu.
20733
20869
  *
20734
20870
  * - **ThreadSafety**: Unsafe
20735
20871
  *
20736
20872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetEmotesMenuOpen)
20737
- * @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.
20738
20874
  * @param isOpen
20739
20875
  */
20740
20876
  SetEmotesMenuOpen(this: GuiService, isOpen: boolean): void;
20741
20877
  /**
20742
- * 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.
20743
20879
  *
20744
20880
  * - **ThreadSafety**: Unsafe
20745
20881
  *
20746
20882
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetGameplayPausedNotificationEnabled)
20747
- * @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.
20748
20884
  * @param enabled Whether or not the built-in notification GUI is disabled.
20749
20885
  */
20750
20886
  SetGameplayPausedNotificationEnabled(this: GuiService, enabled: boolean): void;
20751
20887
  /**
20752
- * Allows developers to enable or disable default Inspect and Buy functionality.
20888
+ * Allows you to enable or disable the avatar inspection menu.
20753
20889
  *
20754
20890
  * - **ThreadSafety**: Unsafe
20755
20891
  *
20756
20892
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#SetInspectMenuEnabled)
20757
- * @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.
20758
- * @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.
20759
20895
  */
20760
20896
  SetInspectMenuEnabled(this: GuiService, enabled: boolean): void;
20761
20897
  /**
20762
- * Fires when the user **closes** the Roblox coregui escape menu.
20898
+ * Fires when the user **closes** the Roblox `CoreGui` escape menu.
20763
20899
  *
20764
20900
  * - **ThreadSafety**: Unsafe
20765
20901
  *
@@ -20767,7 +20903,7 @@ interface GuiService extends Instance {
20767
20903
  */
20768
20904
  readonly MenuClosed: RBXScriptSignal<() => void>;
20769
20905
  /**
20770
- * Fires when the user **opens** the Roblox coregui escape menu.
20906
+ * Fires when the user **opens** the Roblox `CoreGui` escape menu.
20771
20907
  *
20772
20908
  * - **ThreadSafety**: Unsafe
20773
20909
  *
@@ -21376,9 +21512,15 @@ interface HttpService extends Instance {
21376
21512
  */
21377
21513
  get HttpEnabled(): boolean;
21378
21514
  /**
21515
+ * Creates a client that opens a persistent connection to stream data.
21516
+ *
21379
21517
  * - **ThreadSafety**: Unsafe
21380
21518
  *
21381
21519
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#CreateWebStreamClient)
21520
+ * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
21521
+ * @param streamClientType The type of streaming connection to intiialize the client with.
21522
+ * @param requestOptions A dictionary containing information to be requested from the server. It is identical to `requestOptions` in `HttpService:RequestAsync()`.
21523
+ * @returns A stateful client that emits events in the stream lifecycle.
21382
21524
  */
21383
21525
  CreateWebStreamClient(this: HttpService, streamClientType: CastsToEnum<Enum.WebStreamClientType>, requestOptions: object): WebStreamClient;
21384
21526
  /**
@@ -26011,7 +26153,7 @@ interface AuroraScript extends LuaSourceContainer {
26011
26153
  *
26012
26154
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
26013
26155
  */
26014
- AddTo(this: AuroraScript, instance: Instance): void;
26156
+ AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
26015
26157
  /**
26016
26158
  * - **ThreadSafety**: Unsafe
26017
26159
  *
@@ -27280,6 +27422,8 @@ interface Mouse extends Instance {
27280
27422
  */
27281
27423
  Icon: ContentId;
27282
27424
  /**
27425
+ * The content of the image used as the `Mouse` icon. Only supports asset URIs.
27426
+ *
27283
27427
  * - **ThreadSafety**: ReadSafe
27284
27428
  *
27285
27429
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#IconContent)
@@ -28544,8 +28688,6 @@ interface BasePart extends PVInstance {
28544
28688
  */
28545
28689
  GetRenderCFrame(this: BasePart): CFrame;
28546
28690
  /**
28547
- * **Deprecated:**
28548
- *
28549
28691
  * Returns the base part of an assembly of parts.
28550
28692
  *
28551
28693
  * - **ThreadSafety**: Safe
@@ -30646,6 +30788,8 @@ interface BackpackItem extends Model {
30646
30788
  */
30647
30789
  readonly _nominal_BackpackItem: unique symbol;
30648
30790
  /**
30791
+ * The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs.
30792
+ *
30649
30793
  * - **ThreadSafety**: ReadSafe
30650
30794
  *
30651
30795
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BackpackItem#TextureContent)
@@ -30992,6 +31136,7 @@ interface WorldRoot extends Model {
30992
31136
  * Returns an array of parts whose **bounding boxes** overlap a given box.
30993
31137
  *
30994
31138
  * - **ThreadSafety**: Safe
31139
+ * - **Tags**: CustomLuaState
30995
31140
  *
30996
31141
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInBox)
30997
31142
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31005,6 +31150,7 @@ interface WorldRoot extends Model {
31005
31150
  * Returns an array of parts whose **bounding boxes** overlap a given sphere.
31006
31151
  *
31007
31152
  * - **ThreadSafety**: Safe
31153
+ * - **Tags**: CustomLuaState
31008
31154
  *
31009
31155
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInRadius)
31010
31156
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31018,6 +31164,7 @@ interface WorldRoot extends Model {
31018
31164
  * Returns an array of parts whose occupied space is shared with the given part.
31019
31165
  *
31020
31166
  * - **ThreadSafety**: Safe
31167
+ * - **Tags**: CustomLuaState
31021
31168
  *
31022
31169
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartsInPart)
31023
31170
  * @param this Base class for handling physics simulation and 3D spatial queries.
@@ -31122,6 +31269,14 @@ interface Workspace extends WorldRoot {
31122
31269
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirDensity)
31123
31270
  */
31124
31271
  AirDensity: number;
31272
+ /**
31273
+ * Controls the strength of turbulence present in the wind velocity field, affecting the aerodynamic force model.
31274
+ *
31275
+ * - **ThreadSafety**: ReadSafe
31276
+ *
31277
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirTurbulenceIntensity)
31278
+ */
31279
+ AirTurbulenceIntensity: number;
31125
31280
  /**
31126
31281
  * Determines whether assets created by other users can be sold in the game.
31127
31282
  *
@@ -31131,6 +31286,12 @@ interface Workspace extends WorldRoot {
31131
31286
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales)
31132
31287
  */
31133
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;
31134
31295
  /**
31135
31296
  * Specifies the animation throttling mode for the local client.
31136
31297
  *
@@ -35018,6 +35179,13 @@ interface RecommendationService extends Instance {
35018
35179
  * @param generateRecommendationItemListRequest
35019
35180
  */
35020
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;
35021
35189
  /**
35022
35190
  * - **ThreadSafety**: Unsafe
35023
35191
  * - **Tags**: Yields
@@ -35500,6 +35668,13 @@ interface RunService extends Instance {
35500
35668
  * @deprecated
35501
35669
  */
35502
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;
35503
35678
  /**
35504
35679
  * Given a string name of a function and a priority, this method binds the function to `RunService.PreRender`.
35505
35680
  *
@@ -35523,13 +35698,13 @@ interface RunService extends Instance {
35523
35698
  */
35524
35699
  IsClient(this: RunService): boolean;
35525
35700
  /**
35526
- * Returns whether the **Run** button has been pressed to run the simulation in Studio.
35701
+ * Returns whether a **Run** playtest has been initiated in Studio.
35527
35702
  *
35528
35703
  * - **ThreadSafety**: Safe
35529
35704
  *
35530
35705
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#IsRunMode)
35531
35706
  * @param this Service responsible for all runtime activity and progression of time.
35532
- * @returns Whether the **Run** button has been pressed to run the simulation in Studio.
35707
+ * @returns Whether a **Run** playtest has been initiated in Studio.
35533
35708
  */
35534
35709
  IsRunMode(this: RunService): boolean;
35535
35710
  /**
@@ -35572,6 +35747,12 @@ interface RunService extends Instance {
35572
35747
  * @param name The name of the function being unbound.
35573
35748
  */
35574
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>;
35575
35756
  /**
35576
35757
  * Fires every frame, after the physics simulation has completed.
35577
35758
  *
@@ -41428,6 +41609,8 @@ interface TextFilterTranslatedResult extends Instance {
41428
41609
  GetTranslations(this: TextFilterTranslatedResult): object;
41429
41610
  }
41430
41611
  /**
41612
+ * Gives access to a large language model for text generation.
41613
+ *
41431
41614
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
41432
41615
  */
41433
41616
  interface TextGenerator extends Instance {
@@ -41440,16 +41623,47 @@ interface TextGenerator extends Instance {
41440
41623
  */
41441
41624
  readonly _nominal_TextGenerator: unique symbol;
41442
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
+ *
41443
41636
  * - **ThreadSafety**: ReadSafe
41444
41637
  *
41445
41638
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#SystemPrompt)
41446
41639
  */
41447
41640
  SystemPrompt: string;
41448
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
+ *
41449
41660
  * - **ThreadSafety**: Unsafe
41450
41661
  * - **Tags**: Yields
41451
41662
  *
41452
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.
41453
41667
  */
41454
41668
  GenerateTextAsync(this: TextGenerator, request: object): object;
41455
41669
  }
@@ -42378,6 +42592,8 @@ interface UIDragDetector extends UIComponent {
42378
42592
  */
42379
42593
  ActivatedCursorIcon: ContentId;
42380
42594
  /**
42595
+ * Sets the cursor icon to display when the mouse is activated over the parent of this `UIDragDetector`. Only supports asset URIs
42596
+ *
42381
42597
  * - **ThreadSafety**: ReadSafe
42382
42598
  *
42383
42599
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIconContent)
@@ -42408,6 +42624,8 @@ interface UIDragDetector extends UIComponent {
42408
42624
  */
42409
42625
  CursorIcon: ContentId;
42410
42626
  /**
42627
+ * Sets the cursor icon to display when the mouse is hovered over the parent of this `UIDragDetector`. Only asset URIs are supported.
42628
+ *
42411
42629
  * - **ThreadSafety**: ReadSafe
42412
42630
  *
42413
42631
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIconContent)
@@ -43328,6 +43546,12 @@ interface UniqueIdLookupService extends Instance {
43328
43546
  * @deprecated
43329
43547
  */
43330
43548
  readonly _nominal_UniqueIdLookupService: unique symbol;
43549
+ /**
43550
+ * - **ThreadSafety**: Unsafe
43551
+ *
43552
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService#GetOrCreateUniqueIdRemoteCommand)
43553
+ */
43554
+ GetOrCreateUniqueIdRemoteCommand(this: UniqueIdLookupService, instance: Instance): string;
43331
43555
  }
43332
43556
  /**
43333
43557
  * - **Tags**: NotCreatable, Service
@@ -43639,6 +43863,8 @@ interface UserInputService extends Instance {
43639
43863
  */
43640
43864
  MouseIcon: ContentId;
43641
43865
  /**
43866
+ * The content ID of the image for the user's mouse icon. Only supports asset URIs.
43867
+ *
43642
43868
  * - **ThreadSafety**: ReadSafe
43643
43869
  *
43644
43870
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIconContent)
@@ -44994,12 +45220,6 @@ interface VideoPlayer extends Instance {
44994
45220
  * @deprecated
44995
45221
  */
44996
45222
  readonly _nominal_VideoPlayer: unique symbol;
44997
- /**
44998
- * - **ThreadSafety**: ReadSafe
44999
- *
45000
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Asset)
45001
- */
45002
- Asset: ContentId;
45003
45223
  /**
45004
45224
  * - **ThreadSafety**: ReadSafe
45005
45225
  * - **Tags**: NotReplicated
@@ -45763,6 +45983,8 @@ interface TerrainWriteOperation extends RBXObject {
45763
45983
  GetBlock(this: TerrainWriteOperation): object;
45764
45984
  }
45765
45985
  /**
45986
+ * Maintains a streaming connection.
45987
+ *
45766
45988
  * - **Tags**: NotCreatable, NotReplicated
45767
45989
  *
45768
45990
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient)
@@ -45777,6 +45999,8 @@ interface WebStreamClient extends RBXObject {
45777
45999
  */
45778
46000
  readonly _nominal_WebStreamClient: unique symbol;
45779
46001
  /**
46002
+ * The current `WebStreamClientState` of the client.
46003
+ *
45780
46004
  * - **ThreadSafety**: ReadSafe
45781
46005
  * - **Tags**: NotReplicated
45782
46006
  *
@@ -45784,9 +46008,12 @@ interface WebStreamClient extends RBXObject {
45784
46008
  */
45785
46009
  readonly ConnectionState: Enum.WebStreamClientState;
45786
46010
  /**
46011
+ * Closes the client, aborting the ongoing request.
46012
+ *
45787
46013
  * - **ThreadSafety**: Unsafe
45788
46014
  *
45789
46015
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Close)
46016
+ * @param this Maintains a streaming connection.
45790
46017
  */
45791
46018
  Close(this: WebStreamClient): void;
45792
46019
  /**
@@ -45796,18 +46023,24 @@ interface WebStreamClient extends RBXObject {
45796
46023
  */
45797
46024
  readonly Closed: RBXScriptSignal<() => void>;
45798
46025
  /**
46026
+ * Fires if an error is received while establishing the connection or during the connection lifetime.
46027
+ *
45799
46028
  * - **ThreadSafety**: Unsafe
45800
46029
  *
45801
46030
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Error)
45802
46031
  */
45803
46032
  readonly Error: RBXScriptSignal<(responseStatusCode: number, errorMessage: string) => void>;
45804
46033
  /**
46034
+ * Fires each time a message is received from the server.
46035
+ *
45805
46036
  * - **ThreadSafety**: Unsafe
45806
46037
  *
45807
46038
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#MessageReceived)
45808
46039
  */
45809
46040
  readonly MessageReceived: RBXScriptSignal<(message: string) => void>;
45810
46041
  /**
46042
+ * Fires when the a connection is successfully established between the client and server, allowing for events to begin streaming.
46043
+ *
45811
46044
  * - **ThreadSafety**: Unsafe
45812
46045
  *
45813
46046
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Opened)
@@ -291,6 +291,7 @@ interface CreatableInstances {
291
291
  AudioSearchParams: AudioSearchParams;
292
292
  AudioSpeechToText: AudioSpeechToText;
293
293
  AudioTextToSpeech: AudioTextToSpeech;
294
+ AudioTremolo: AudioTremolo;
294
295
  AuroraScript: AuroraScript;
295
296
  AvatarAccessoryRules: AvatarAccessoryRules;
296
297
  AvatarAnimationRules: AvatarAnimationRules;
@@ -1911,6 +1912,23 @@ interface AudioTextToSpeech extends Instance {
1911
1912
  */
1912
1913
  readonly _nominal_AudioTextToSpeech: unique symbol;
1913
1914
  }
1915
+ /**
1916
+ * Creates a trembling effect on a sound by varying the volume of the sound up and down.
1917
+ *
1918
+ * - **Tags**: NotBrowsable
1919
+ *
1920
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
1921
+ */
1922
+ interface AudioTremolo extends Instance {
1923
+ /**
1924
+ * **DO NOT USE!**
1925
+ *
1926
+ * This field exists to force TypeScript to recognize this as a nominal type
1927
+ * @hidden
1928
+ * @deprecated
1929
+ */
1930
+ readonly _nominal_AudioTremolo: unique symbol;
1931
+ }
1914
1932
  /**
1915
1933
  * - **Tags**: NotCreatable
1916
1934
  *
@@ -6595,7 +6613,7 @@ interface Path2D extends GuiBase {
6595
6613
  readonly _nominal_Path2D: unique symbol;
6596
6614
  }
6597
6615
  /**
6598
- * 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.
6599
6617
  *
6600
6618
  * - **Tags**: NotCreatable, Service, NotReplicated
6601
6619
  *
@@ -13928,6 +13946,8 @@ interface TextFilterTranslatedResult extends Instance {
13928
13946
  readonly _nominal_TextFilterTranslatedResult: unique symbol;
13929
13947
  }
13930
13948
  /**
13949
+ * Gives access to a large language model for text generation.
13950
+ *
13931
13951
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator)
13932
13952
  */
13933
13953
  interface TextGenerator extends Instance {
@@ -15237,6 +15257,8 @@ interface TerrainWriteOperation extends RBXObject {
15237
15257
  readonly _nominal_TerrainWriteOperation: unique symbol;
15238
15258
  }
15239
15259
  /**
15260
+ * Maintains a streaming connection.
15261
+ *
15240
15262
  * - **Tags**: NotCreatable, NotReplicated
15241
15263
  *
15242
15264
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient)
@@ -8816,7 +8816,7 @@ declare namespace Enum {
8816
8816
  }
8817
8817
  export const GetSortedAsync: GetSortedAsync;
8818
8818
  /**
8819
- * Refers to `SetAsync()` and `IncrementAsync()` while using an `OrderedDataStore`.
8819
+ * Refers to `SetAsync()` `IncrementAsync()`, `RemoveAsync()`, and the write of `UpdateAsync()` while using an `OrderedDataStore`.
8820
8820
  *
8821
8821
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementSortedAsync)
8822
8822
  */
@@ -21635,11 +21635,20 @@ declare namespace Enum {
21635
21635
  EnumType: typeof globalThis.Enum.OutfitType;
21636
21636
  }
21637
21637
  export const DynamicHead: DynamicHead;
21638
+ /**
21639
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#Shoes)
21640
+ */
21641
+ export interface Shoes extends globalThis.EnumItem {
21642
+ Name: "Shoes";
21643
+ Value: 4;
21644
+ EnumType: typeof globalThis.Enum.OutfitType;
21645
+ }
21646
+ export const Shoes: Shoes;
21638
21647
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.OutfitType>;
21639
21648
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.OutfitType | undefined;
21640
21649
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.OutfitType | undefined;
21641
21650
  }
21642
- export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead;
21651
+ export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead | OutfitType.Shoes;
21643
21652
  /**
21644
21653
  * Sets the layout mode of the output.
21645
21654
  *
@@ -23266,28 +23275,28 @@ declare namespace Enum {
23266
23275
  }
23267
23276
  export const Auto: Auto;
23268
23277
  /**
23269
- * [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)
23270
23279
  */
23271
- export interface None extends globalThis.EnumItem {
23272
- Name: "None";
23280
+ export interface On extends globalThis.EnumItem {
23281
+ Name: "On";
23273
23282
  Value: 1;
23274
23283
  EnumType: typeof globalThis.Enum.PredictionMode;
23275
23284
  }
23276
- export const None: None;
23285
+ export const On: On;
23277
23286
  /**
23278
- * [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)
23279
23288
  */
23280
- export interface Forced extends globalThis.EnumItem {
23281
- Name: "Forced";
23289
+ export interface Off extends globalThis.EnumItem {
23290
+ Name: "Off";
23282
23291
  Value: 2;
23283
23292
  EnumType: typeof globalThis.Enum.PredictionMode;
23284
23293
  }
23285
- export const Forced: Forced;
23294
+ export const Off: Off;
23286
23295
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PredictionMode>;
23287
23296
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PredictionMode | undefined;
23288
23297
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PredictionMode | undefined;
23289
23298
  }
23290
- export type PredictionMode = PredictionMode.Auto | PredictionMode.None | PredictionMode.Forced;
23299
+ export type PredictionMode = PredictionMode.Auto | PredictionMode.On | PredictionMode.Off;
23291
23300
  /**
23292
23301
  * This enum is used with `UserInputService.PreferredInput` to indicate the primary input type a player is likely using.
23293
23302
  *
@@ -23333,10 +23342,14 @@ declare namespace Enum {
23333
23342
  }
23334
23343
  export type PreferredInput = PreferredInput.KeyboardAndMouse | PreferredInput.Gamepad | PreferredInput.Touch;
23335
23344
  /**
23345
+ * This enum is used with `GuiService.PreferredTextSize` to indicate the player's preferred text size.
23346
+ *
23336
23347
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize)
23337
23348
  */
23338
23349
  export namespace PreferredTextSize {
23339
23350
  /**
23351
+ * The player prefers default text size.
23352
+ *
23340
23353
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Medium)
23341
23354
  */
23342
23355
  export interface Medium extends globalThis.EnumItem {
@@ -23346,6 +23359,8 @@ declare namespace Enum {
23346
23359
  }
23347
23360
  export const Medium: Medium;
23348
23361
  /**
23362
+ * The player prefers text size slightly increased beyond default.
23363
+ *
23349
23364
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Large)
23350
23365
  */
23351
23366
  export interface Large extends globalThis.EnumItem {
@@ -23355,6 +23370,8 @@ declare namespace Enum {
23355
23370
  }
23356
23371
  export const Large: Large;
23357
23372
  /**
23373
+ * The player prefers text size moderately increased beyond default.
23374
+ *
23358
23375
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Larger)
23359
23376
  */
23360
23377
  export interface Larger extends globalThis.EnumItem {
@@ -23364,6 +23381,8 @@ declare namespace Enum {
23364
23381
  }
23365
23382
  export const Larger: Larger;
23366
23383
  /**
23384
+ * The player prefers text size considerably increased beyond default.
23385
+ *
23367
23386
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Largest)
23368
23387
  */
23369
23388
  export interface Largest extends globalThis.EnumItem {
@@ -32857,6 +32876,60 @@ declare namespace Enum {
32857
32876
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UiMessageType | undefined;
32858
32877
  }
32859
32878
  export type UiMessageType = UiMessageType.UiMessageError | UiMessageType.UiMessageInfo;
32879
+ /**
32880
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState)
32881
+ */
32882
+ export namespace UpdateState {
32883
+ /**
32884
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateNotAvailable)
32885
+ */
32886
+ export interface UpdateNotAvailable extends globalThis.EnumItem {
32887
+ Name: "UpdateNotAvailable";
32888
+ Value: 0;
32889
+ EnumType: typeof globalThis.Enum.UpdateState;
32890
+ }
32891
+ export const UpdateNotAvailable: UpdateNotAvailable;
32892
+ /**
32893
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateAvailable)
32894
+ */
32895
+ export interface UpdateAvailable extends globalThis.EnumItem {
32896
+ Name: "UpdateAvailable";
32897
+ Value: 1;
32898
+ EnumType: typeof globalThis.Enum.UpdateState;
32899
+ }
32900
+ export const UpdateAvailable: UpdateAvailable;
32901
+ /**
32902
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateInProgress)
32903
+ */
32904
+ export interface UpdateInProgress extends globalThis.EnumItem {
32905
+ Name: "UpdateInProgress";
32906
+ Value: 2;
32907
+ EnumType: typeof globalThis.Enum.UpdateState;
32908
+ }
32909
+ export const UpdateInProgress: UpdateInProgress;
32910
+ /**
32911
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateReady)
32912
+ */
32913
+ export interface UpdateReady extends globalThis.EnumItem {
32914
+ Name: "UpdateReady";
32915
+ Value: 3;
32916
+ EnumType: typeof globalThis.Enum.UpdateState;
32917
+ }
32918
+ export const UpdateReady: UpdateReady;
32919
+ /**
32920
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateFailed)
32921
+ */
32922
+ export interface UpdateFailed extends globalThis.EnumItem {
32923
+ Name: "UpdateFailed";
32924
+ Value: 4;
32925
+ EnumType: typeof globalThis.Enum.UpdateState;
32926
+ }
32927
+ export const UpdateFailed: UpdateFailed;
32928
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UpdateState>;
32929
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.UpdateState | undefined;
32930
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UpdateState | undefined;
32931
+ }
32932
+ export type UpdateState = UpdateState.UpdateNotAvailable | UpdateState.UpdateAvailable | UpdateState.UpdateInProgress | UpdateState.UpdateReady | UpdateState.UpdateFailed;
32860
32933
  /**
32861
32934
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult)
32862
32935
  */
@@ -34662,10 +34735,14 @@ declare namespace Enum {
34662
34735
  }
34663
34736
  export type WebSocketState = WebSocketState.Connecting | WebSocketState.Open | WebSocketState.Closing | WebSocketState.Closed;
34664
34737
  /**
34738
+ * WebStreamClientState indicates the current state of a WebStreamClient object.
34739
+ *
34665
34740
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState)
34666
34741
  */
34667
34742
  export namespace WebStreamClientState {
34668
34743
  /**
34744
+ * The client has sent a request to connect with the server and is waiting for a response.
34745
+ *
34669
34746
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Connecting)
34670
34747
  */
34671
34748
  export interface Connecting extends globalThis.EnumItem {
@@ -34675,6 +34752,8 @@ declare namespace Enum {
34675
34752
  }
34676
34753
  export const Connecting: Connecting;
34677
34754
  /**
34755
+ * The client is connected to the server, allowing for data to be streamed between the server and client.
34756
+ *
34678
34757
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Open)
34679
34758
  */
34680
34759
  export interface Open extends globalThis.EnumItem {
@@ -34684,6 +34763,8 @@ declare namespace Enum {
34684
34763
  }
34685
34764
  export const Open: Open;
34686
34765
  /**
34766
+ * An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream.
34767
+ *
34687
34768
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Error)
34688
34769
  */
34689
34770
  export interface Error extends globalThis.EnumItem {
@@ -34693,6 +34774,8 @@ declare namespace Enum {
34693
34774
  }
34694
34775
  export const Error: Error;
34695
34776
  /**
34777
+ * The connection has run to completion without issues, either closed naturally by the server or manually by the user.
34778
+ *
34696
34779
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Closed)
34697
34780
  */
34698
34781
  export interface Closed extends globalThis.EnumItem {
@@ -34707,10 +34790,14 @@ declare namespace Enum {
34707
34790
  }
34708
34791
  export type WebStreamClientState = WebStreamClientState.Connecting | WebStreamClientState.Open | WebStreamClientState.Error | WebStreamClientState.Closed;
34709
34792
  /**
34793
+ * Specifies what type of streaming to use when creating a `WebStreamClient`.
34794
+ *
34710
34795
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType)
34711
34796
  */
34712
34797
  export namespace WebStreamClientType {
34713
34798
  /**
34799
+ * Traditional Server-Sent Events (SSE) client. Requires `text/event-stream` to be returned in the `Content-Type` header. Messages in the stream will follow the [event stream format](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format).
34800
+ *
34714
34801
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#SSE)
34715
34802
  */
34716
34803
  export interface SSE extends globalThis.EnumItem {
@@ -34720,6 +34807,8 @@ declare namespace Enum {
34720
34807
  }
34721
34808
  export const SSE: SSE;
34722
34809
  /**
34810
+ * The client can connect to any server that provides streaming data transfer (e.g. [chunked encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Transfer-Encoding)). It provides no guarantees about the stream format.
34811
+ *
34723
34812
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#RawStream)
34724
34813
  */
34725
34814
  export interface RawStream extends globalThis.EnumItem {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.879",
3
+ "version": "1.0.881",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },