@rbxts/types 1.0.878 → 1.0.880

package/include/generated/None.d.ts

@@ -273,6 +273,7 @@ interface CreatableInstances {
     AudioSearchParams: AudioSearchParams;
     AudioSpeechToText: AudioSpeechToText;
     AudioTextToSpeech: AudioTextToSpeech;
+    AudioTremolo: AudioTremolo;
     AuroraScript: AuroraScript;
     AvatarAccessoryRules: AvatarAccessoryRules;
     AvatarAnimationRules: AvatarAnimationRules;
@@ -6806,6 +6807,87 @@ interface AudioTextToSpeech extends Instance {
      */
     readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
 }
+/**
+ * - **Tags**: NotBrowsable
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
+ */
+interface AudioTremolo extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_AudioTremolo: unique symbol;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Bypass)
+     */
+    Bypass: boolean;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Depth)
+     */
+    Depth: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Duty)
+     */
+    Duty: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Frequency)
+     */
+    Frequency: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Shape)
+     */
+    Shape: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Skew)
+     */
+    Skew: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Square)
+     */
+    Square: number;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
+     */
+    GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
+     */
+    GetInputPins(this: AudioTremolo): Array<unknown>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
+     */
+    GetOutputPins(this: AudioTremolo): Array<unknown>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#WiringChanged)
+     */
+    readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
+}
 /**
  * - **Tags**: NotCreatable
  *
@@ -6857,6 +6939,20 @@ interface AuroraScriptService extends Instance {
      * @deprecated
      */
     readonly _nominal_AuroraScriptService: unique symbol;
+    /**
+     * - **ThreadSafety**: Safe
+     * - **Tags**: CustomLuaState
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
+     */
+    FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
+    /**
+     * - **ThreadSafety**: Safe
+     * - **Tags**: CustomLuaState
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
+     */
+    FindBindings(this: AuroraScriptService, instance: Instance): object;
     /**
      * - **ThreadSafety**: Safe
      *
@@ -10300,6 +10396,8 @@ interface ClickDetector extends Instance {
      */
     CursorIcon: ContentId;
     /**
+     * Sets the cursor icon to display when the mouse is hovered over the parent of this `ClickDetector` or `DragDetector`. Only supports asset URIs.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIconContent)
@@ -10369,6 +10467,8 @@ interface DragDetector extends ClickDetector {
      */
     ActivatedCursorIcon: ContentId;
     /**
+     * Sets the cursor icon to display when the mouse is activated over the parent of this `DragDetector`. Only supports asset URIs
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIconContent)
@@ -21376,9 +21476,15 @@ interface HttpService extends Instance {
      */
     get HttpEnabled(): boolean;
     /**
+     * Creates a client that opens a persistent connection to stream data.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#CreateWebStreamClient)
+     * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
+     * @param streamClientType The type of streaming connection to intiialize the client with.
+     * @param requestOptions A dictionary containing information to be requested from the server. It is identical to `requestOptions` in `HttpService:RequestAsync()`.
+     * @returns A stateful client that emits events in the stream lifecycle.
      */
     CreateWebStreamClient(this: HttpService, streamClientType: CastsToEnum<Enum.WebStreamClientType>, requestOptions: object): WebStreamClient;
     /**
@@ -26011,7 +26117,7 @@ interface AuroraScript extends LuaSourceContainer {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
      */
-    AddTo(this: AuroraScript, instance: Instance): void;
+    AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
     /**
      * - **ThreadSafety**: Unsafe
      *
@@ -27280,6 +27386,8 @@ interface Mouse extends Instance {
      */
     Icon: ContentId;
     /**
+     * The content of the image used as the `Mouse` icon. Only supports asset URIs.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#IconContent)
@@ -30646,6 +30754,8 @@ interface BackpackItem extends Model {
      */
     readonly _nominal_BackpackItem: unique symbol;
     /**
+     * The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BackpackItem#TextureContent)
@@ -31122,6 +31232,12 @@ interface Workspace extends WorldRoot {
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirDensity)
      */
     AirDensity: number;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AirTurbulenceIntensity)
+     */
+    AirTurbulenceIntensity: number;
     /**
      * Determines whether assets created by other users can be sold in the game.
      *
@@ -35523,13 +35639,13 @@ interface RunService extends Instance {
      */
     IsClient(this: RunService): boolean;
     /**
-     * Returns whether the **Run** button has been pressed to run the simulation in Studio.
+     * Returns whether a **Run** playtest has been initiated in Studio.
      *
      * - **ThreadSafety**: Safe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#IsRunMode)
      * @param this Service responsible for all runtime activity and progression of time.
-     * @returns Whether the **Run** button has been pressed to run the simulation in Studio.
+     * @returns Whether a **Run** playtest has been initiated in Studio.
      */
     IsRunMode(this: RunService): boolean;
     /**
@@ -42378,6 +42494,8 @@ interface UIDragDetector extends UIComponent {
      */
     ActivatedCursorIcon: ContentId;
     /**
+     * Sets the cursor icon to display when the mouse is activated over the parent of this `UIDragDetector`. Only supports asset URIs
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIconContent)
@@ -42408,6 +42526,8 @@ interface UIDragDetector extends UIComponent {
      */
     CursorIcon: ContentId;
     /**
+     * Sets the cursor icon to display when the mouse is hovered over the parent of this `UIDragDetector`. Only asset URIs are supported.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIconContent)
@@ -43328,6 +43448,12 @@ interface UniqueIdLookupService extends Instance {
      * @deprecated
      */
     readonly _nominal_UniqueIdLookupService: unique symbol;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService#GetOrCreateUniqueIdRemoteCommand)
+     */
+    GetOrCreateUniqueIdRemoteCommand(this: UniqueIdLookupService, instance: Instance): string;
 }
 /**
  * - **Tags**: NotCreatable, Service
@@ -43639,6 +43765,8 @@ interface UserInputService extends Instance {
      */
     MouseIcon: ContentId;
     /**
+     * The content ID of the image for the user's mouse icon. Only supports asset URIs.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIconContent)
@@ -45763,6 +45891,8 @@ interface TerrainWriteOperation extends RBXObject {
     GetBlock(this: TerrainWriteOperation): object;
 }
 /**
+ * Maintains a streaming connection.
+ *
  * - **Tags**: NotCreatable, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient)
@@ -45777,6 +45907,8 @@ interface WebStreamClient extends RBXObject {
      */
     readonly _nominal_WebStreamClient: unique symbol;
     /**
+     * The current `WebStreamClientState` of the client.
+     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: NotReplicated
      *
@@ -45784,9 +45916,12 @@ interface WebStreamClient extends RBXObject {
      */
     readonly ConnectionState: Enum.WebStreamClientState;
     /**
+     * Closes the client, aborting the ongoing request.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Close)
+     * @param this Maintains a streaming connection.
      */
     Close(this: WebStreamClient): void;
     /**
@@ -45796,18 +45931,24 @@ interface WebStreamClient extends RBXObject {
      */
     readonly Closed: RBXScriptSignal<() => void>;
     /**
+     * Fires if an error is received while establishing the connection or during the connection lifetime.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Error)
      */
     readonly Error: RBXScriptSignal<(responseStatusCode: number, errorMessage: string) => void>;
     /**
+     * Fires each time a message is received from the server.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#MessageReceived)
      */
     readonly MessageReceived: RBXScriptSignal<(message: string) => void>;
     /**
+     * Fires when the a connection is successfully established between the client and server, allowing for events to begin streaming.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Opened)

package/include/generated/PluginSecurity.d.ts

@@ -291,6 +291,7 @@ interface CreatableInstances {
     AudioSearchParams: AudioSearchParams;
     AudioSpeechToText: AudioSpeechToText;
     AudioTextToSpeech: AudioTextToSpeech;
+    AudioTremolo: AudioTremolo;
     AuroraScript: AuroraScript;
     AvatarAccessoryRules: AvatarAccessoryRules;
     AvatarAnimationRules: AvatarAnimationRules;
@@ -1911,6 +1912,21 @@ interface AudioTextToSpeech extends Instance {
      */
     readonly _nominal_AudioTextToSpeech: unique symbol;
 }
+/**
+ * - **Tags**: NotBrowsable
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo)
+ */
+interface AudioTremolo extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_AudioTremolo: unique symbol;
+}
 /**
  * - **Tags**: NotCreatable
  *
@@ -15237,6 +15253,8 @@ interface TerrainWriteOperation extends RBXObject {
     readonly _nominal_TerrainWriteOperation: unique symbol;
 }
 /**
+ * Maintains a streaming connection.
+ *
  * - **Tags**: NotCreatable, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient)

package/include/generated/enums.d.ts

@@ -8816,7 +8816,7 @@ declare namespace Enum {
         }
         export const GetSortedAsync: GetSortedAsync;
         /**
-         * Refers to `SetAsync()` and `IncrementAsync()` while using an `OrderedDataStore`.
+         * Refers to `SetAsync()` `IncrementAsync()`, `RemoveAsync()`, and the write of `UpdateAsync()` while using an `OrderedDataStore`.
          *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementSortedAsync)
          */
@@ -21635,11 +21635,20 @@ declare namespace Enum {
             EnumType: typeof globalThis.Enum.OutfitType;
         }
         export const DynamicHead: DynamicHead;
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#Shoes)
+         */
+        export interface Shoes extends globalThis.EnumItem {
+            Name: "Shoes";
+            Value: 4;
+            EnumType: typeof globalThis.Enum.OutfitType;
+        }
+        export const Shoes: Shoes;
         export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.OutfitType>;
         export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.OutfitType | undefined;
         export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.OutfitType | undefined;
     }
-    export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead;
+    export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead | OutfitType.Shoes;
     /**
      * Sets the layout mode of the output.
      *
@@ -32857,6 +32866,60 @@ declare namespace Enum {
         export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UiMessageType | undefined;
     }
     export type UiMessageType = UiMessageType.UiMessageError | UiMessageType.UiMessageInfo;
+    /**
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState)
+     */
+    export namespace UpdateState {
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateNotAvailable)
+         */
+        export interface UpdateNotAvailable extends globalThis.EnumItem {
+            Name: "UpdateNotAvailable";
+            Value: 0;
+            EnumType: typeof globalThis.Enum.UpdateState;
+        }
+        export const UpdateNotAvailable: UpdateNotAvailable;
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateAvailable)
+         */
+        export interface UpdateAvailable extends globalThis.EnumItem {
+            Name: "UpdateAvailable";
+            Value: 1;
+            EnumType: typeof globalThis.Enum.UpdateState;
+        }
+        export const UpdateAvailable: UpdateAvailable;
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateInProgress)
+         */
+        export interface UpdateInProgress extends globalThis.EnumItem {
+            Name: "UpdateInProgress";
+            Value: 2;
+            EnumType: typeof globalThis.Enum.UpdateState;
+        }
+        export const UpdateInProgress: UpdateInProgress;
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateReady)
+         */
+        export interface UpdateReady extends globalThis.EnumItem {
+            Name: "UpdateReady";
+            Value: 3;
+            EnumType: typeof globalThis.Enum.UpdateState;
+        }
+        export const UpdateReady: UpdateReady;
+        /**
+         * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UpdateState#UpdateFailed)
+         */
+        export interface UpdateFailed extends globalThis.EnumItem {
+            Name: "UpdateFailed";
+            Value: 4;
+            EnumType: typeof globalThis.Enum.UpdateState;
+        }
+        export const UpdateFailed: UpdateFailed;
+        export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UpdateState>;
+        export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.UpdateState | undefined;
+        export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UpdateState | undefined;
+    }
+    export type UpdateState = UpdateState.UpdateNotAvailable | UpdateState.UpdateAvailable | UpdateState.UpdateInProgress | UpdateState.UpdateReady | UpdateState.UpdateFailed;
     /**
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult)
      */
@@ -34662,10 +34725,14 @@ declare namespace Enum {
     }
     export type WebSocketState = WebSocketState.Connecting | WebSocketState.Open | WebSocketState.Closing | WebSocketState.Closed;
     /**
+     * WebStreamClientState indicates the current state of a WebStreamClient object.
+     *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState)
      */
     export namespace WebStreamClientState {
         /**
+         * The client has sent a request to connect with the server and is waiting for a response.
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Connecting)
          */
         export interface Connecting extends globalThis.EnumItem {
@@ -34675,6 +34742,8 @@ declare namespace Enum {
         }
         export const Connecting: Connecting;
         /**
+         * The client is connected to the server, allowing for data to be streamed between the server and client.
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Open)
          */
         export interface Open extends globalThis.EnumItem {
@@ -34684,6 +34753,8 @@ declare namespace Enum {
         }
         export const Open: Open;
         /**
+         * An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream.
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Error)
          */
         export interface Error extends globalThis.EnumItem {
@@ -34693,6 +34764,8 @@ declare namespace Enum {
         }
         export const Error: Error;
         /**
+         * The connection has run to completion without issues, either closed naturally by the server or manually by the user.
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Closed)
          */
         export interface Closed extends globalThis.EnumItem {
@@ -34707,10 +34780,14 @@ declare namespace Enum {
     }
     export type WebStreamClientState = WebStreamClientState.Connecting | WebStreamClientState.Open | WebStreamClientState.Error | WebStreamClientState.Closed;
     /**
+     * Specifies what type of streaming to use when creating a `WebStreamClient`.
+     *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType)
      */
     export namespace WebStreamClientType {
         /**
+         * 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).
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#SSE)
          */
         export interface SSE extends globalThis.EnumItem {
@@ -34720,6 +34797,8 @@ declare namespace Enum {
         }
         export const SSE: SSE;
         /**
+         * 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.
+         *
          * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#RawStream)
          */
         export interface RawStream extends globalThis.EnumItem {

package/include/roblox.d.ts

@@ -76,9 +76,9 @@ interface GetGroupsAsyncResult {
 	IsInClan: boolean;
 }
 
-type HttpHeaders = Record<string, string> | Map<string, string>;
+type HttpHeaders = Record<string, string | Secret> | Map<string, string | Secret>;
 interface RequestAsyncRequest {
-	Url: string;
+	Url: string | Secret;
 	Method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH";
 	Body?: string;
 	Headers?: HttpHeaders;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rbxts/types",
-	"version": "1.0.878",
+	"version": "1.0.880",
 	"publishConfig": {
 		"access": "public"
 	},