@rbxts/types 1.0.917 → 1.0.919

package/include/generated/PluginSecurity.d.ts

@@ -40,6 +40,7 @@ interface Services {
     ChangeHistoryStreamingService: ChangeHistoryStreamingService;
     Chat: Chat;
     CloudCRUDService: CloudCRUDService;
+    CloudExecutionService: CloudExecutionService;
     CollaboratorsService: CollaboratorsService;
     CollectionService: CollectionService;
     CommerceService: CommerceService;
@@ -139,6 +140,7 @@ interface Services {
     NetworkSettings: NetworkSettings;
     OmniRecommendationsService: OmniRecommendationsService;
     OpenCloudService: OpenCloudService;
+    Packages: Packages;
     PackageService: PackageService;
     PackageUIService: PackageUIService;
     PartyEmulatorService: PartyEmulatorService;
@@ -3433,6 +3435,21 @@ interface CloudCRUDService extends Instance {
      */
     readonly _nominal_CloudCRUDService: unique symbol;
 }
+/**
+ * - **Tags**: NotCreatable, Service, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CloudExecutionService)
+ */
+interface CloudExecutionService extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_CloudExecutionService: unique symbol;
+}
 /**
  * Renders realistic clouds that drift slowly across the sky.
  *
@@ -4496,8 +4513,6 @@ interface DataStoreSetOptions extends Instance {
 /**
  * Allows scheduling the guaranteed destruction of an object without yielding.
  *
- *  .
- *
  * - **Tags**: NotCreatable, Service
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Debris)
@@ -5898,6 +5913,8 @@ interface Folder extends Instance {
     readonly _nominal_Folder: unique symbol;
 }
 /**
+ * A container that stores `ProceduralModel` generation results.
+ *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder)
  */
 interface GeneratedFolder extends Folder {
@@ -9021,6 +9038,60 @@ interface NetworkSettings extends Instance {
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#FreeMemoryMBytes)
      */
     readonly FreeMemoryMBytes: number;
+    /**
+     * Adds jitter to playtest connections in the server-to-client direction.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#InboundNetworkJitterMs)
+     */
+    InboundNetworkJitterMs: number;
+    /**
+     * Sets the probability that packets on playtest connections from server to client are dropped.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#InboundNetworkLossPercent)
+     */
+    InboundNetworkLossPercent: number;
+    /**
+     * Adds latency to playtest connections in the server-to-client direction.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#InboundNetworkMinDelayMs)
+     */
+    InboundNetworkMinDelayMs: number;
+    /**
+     * Adds jitter to playtest connections in the client-to-server direction.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#OutboundNetworkJitterMs)
+     */
+    OutboundNetworkJitterMs: number;
+    /**
+     * Sets the probability that packets on playtest connections from client to server are dropped.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#OutboundNetworkLossPercent)
+     */
+    OutboundNetworkLossPercent: number;
+    /**
+     * Adds latency to playtest connections in the client-to-server direction.
+     *
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#OutboundNetworkMinDelayMs)
+     */
+    OutboundNetworkMinDelayMs: number;
 }
 /**
  * An instance used to prevent collisions between two specific parts.
@@ -9572,6 +9643,8 @@ interface Tool extends BackpackItem {
     readonly _nominal_Tool: unique symbol;
 }
 /**
+ * Procedural models support edit-time procedural generation. Instead of manually constructing model content, a procedural model generates its contents automatically in response to parameter changes.
+ *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel)
  */
 interface ProceduralModel extends Model {
@@ -9643,6 +9716,8 @@ interface Workspace extends WorldRoot {
      */
     readonly _nominal_Workspace: unique symbol;
     /**
+     * Controls whether parts that fall below `Workspace.FallenPartsDestroyHeight` are automatically destroyed.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#FallHeightEnabled)
@@ -9668,6 +9743,8 @@ interface Workspace extends WorldRoot {
      */
     set InterpolationThrottling(value: Enum.InterpolationThrottlingMode);
     /**
+     * Sets the Luau type checking mode for scripts in the experience.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#LuauTypeCheckMode)
@@ -9783,6 +9860,21 @@ interface PackageUIService extends Instance {
      */
     readonly _nominal_PackageUIService: unique symbol;
 }
+/**
+ * - **Tags**: NotCreatable, Service
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Packages)
+ */
+interface Packages extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_Packages: unique symbol;
+}
 /**
  * An abstract class for pages objects.
  *
@@ -11179,6 +11271,8 @@ interface PluginCapabilities extends Instance {
     readonly _nominal_PluginCapabilities: unique symbol;
 }
 /**
+ * This service is used by plugins to communicate with other instances of themselves running in other data models.
+ *
  * - **Tags**: NotCreatable, Service, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService)
@@ -11193,18 +11287,29 @@ interface PluginConnectionService extends Instance {
      */
     readonly _nominal_PluginConnectionService: unique symbol;
     /**
+     * Checks if the current data model context can ever have connections of a given type.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService#CanHaveConnectionType)
+     * @param this This service is used by plugins to communicate with other instances of themselves running in other data models.
+     * @param type The connection type to check.
      */
     CanHaveConnectionType(this: PluginConnectionService, type: CastsToEnum<Enum.PluginConnectionTargetType>): boolean;
     /**
+     * Returns a list of currently connected `PluginConnection` objects with the given connection type.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService#GetPluginConnectionsOfType)
+     * @param this This service is used by plugins to communicate with other instances of themselves running in other data models.
+     * @param type The connection type to check.
+     * @returns An array of the currently connected `PluginConnection` objects with that target type.
      */
     GetPluginConnectionsOfType(this: PluginConnectionService, type: CastsToEnum<Enum.PluginConnectionTargetType>): Array<unknown>;
     /**
+     * Fires just after a new `PluginConnection` successfully connects.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService#Connected)
@@ -14039,6 +14144,8 @@ interface StudioDeviceEmulatorService extends Instance {
     readonly _nominal_StudioDeviceEmulatorService: unique symbol;
 }
 /**
+ * Service allowing you to control Studio's Device Simulator.
+ *
  * - **Tags**: NotCreatable, Service, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService)
@@ -14057,6 +14164,9 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#CreateDeviceAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param config
+     * @returns string
      */
     CreateDeviceAsync(this: StudioDeviceSimulatorService, config: object): string;
     /**
@@ -14064,6 +14174,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns string
      */
     GetDeviceAsync(this: StudioDeviceSimulatorService): string;
     /**
@@ -14071,6 +14183,9 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceInfoAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param deviceId
+     * @returns A dictionary containing the device configuration and passed to `CreateDeviceAsync` and `UpdateDeviceAsync`.
      */
     GetDeviceInfoAsync(this: StudioDeviceSimulatorService, deviceId: string): object;
     /**
@@ -14078,6 +14193,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetDeviceListAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns An array of device IDs.
      */
     GetDeviceListAsync(this: StudioDeviceSimulatorService): Array<unknown>;
     /**
@@ -14085,6 +14202,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetOrientationAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns ScreenOrientation
      */
     GetOrientationAsync(this: StudioDeviceSimulatorService): Enum.ScreenOrientation;
     /**
@@ -14092,6 +14211,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetPixelDensityAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns number
      */
     GetPixelDensityAsync(this: StudioDeviceSimulatorService): number;
     /**
@@ -14099,6 +14220,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetResolutionAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns Vector2
      */
     GetResolutionAsync(this: StudioDeviceSimulatorService): Vector2;
     /**
@@ -14106,6 +14229,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#GetScalingModeAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @returns DeviceSimulatorScalingMode
      */
     GetScalingModeAsync(this: StudioDeviceSimulatorService): Enum.DeviceSimulatorScalingMode;
     /**
@@ -14113,6 +14238,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#RemoveDeviceAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param deviceId
      */
     RemoveDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
     /**
@@ -14120,6 +14247,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetDeviceAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param deviceId
      */
     SetDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string): void;
     /**
@@ -14127,6 +14256,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetOrientationAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param orientation
      */
     SetOrientationAsync(this: StudioDeviceSimulatorService, orientation: CastsToEnum<Enum.ScreenOrientation>): void;
     /**
@@ -14134,6 +14265,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetPixelDensityAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param density
      */
     SetPixelDensityAsync(this: StudioDeviceSimulatorService, density: number): void;
     /**
@@ -14141,6 +14274,9 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetResolutionAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param width
+     * @param height
      */
     SetResolutionAsync(this: StudioDeviceSimulatorService, width: number, height: number): void;
     /**
@@ -14148,6 +14284,8 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#SetScalingModeAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param mode
      */
     SetScalingModeAsync(this: StudioDeviceSimulatorService, mode: CastsToEnum<Enum.DeviceSimulatorScalingMode>): void;
     /**
@@ -14155,6 +14293,7 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#StopSimulationAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
      */
     StopSimulationAsync(this: StudioDeviceSimulatorService): void;
     /**
@@ -14162,6 +14301,9 @@ interface StudioDeviceSimulatorService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioDeviceSimulatorService#UpdateDeviceAsync)
+     * @param this Service allowing you to control Studio's Device Simulator.
+     * @param deviceId
+     * @param config
      */
     UpdateDeviceAsync(this: StudioDeviceSimulatorService, deviceId: string, config: object): void;
     /**
@@ -14447,6 +14589,9 @@ interface StudioTestService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecuteMultiplayerTestAsync)
+     * @param this Service allowing plugins to automate and customize Test and Run mode testing.
+     * @param numPlayers
+     * @param args
      */
     ExecuteMultiplayerTestAsync(this: StudioTestService, numPlayers: number, args: unknown): unknown;
     /**
@@ -16041,12 +16186,6 @@ interface UserInputService extends Instance {
      * @deprecated
      */
     readonly _nominal_UserInputService: unique symbol;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#CreateVirtualInput)
-     */
-    CreateVirtualInput(this: UserInputService): RBXObject;
 }
 /**
  * A service that handles queries regarding users on the Roblox platform.
@@ -16678,6 +16817,8 @@ interface OutputLink extends RBXObject {
     readonly _nominal_OutputLink: unique symbol;
 }
 /**
+ * Encapsulates a connection between the current data model and another for plugin communication.
+ *
  * - **Tags**: NotCreatable, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection)
@@ -16692,6 +16833,8 @@ interface PluginConnection extends RBXObject {
      */
     readonly _nominal_PluginConnection: unique symbol;
     /**
+     * Whether this `PluginConnection` object is still connected.
+     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: NotReplicated
      *
@@ -16699,6 +16842,8 @@ interface PluginConnection extends RBXObject {
      */
     readonly Connected: boolean;
     /**
+     * A unique ID for the target data model.
+     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: NotReplicated
      *
@@ -16706,6 +16851,8 @@ interface PluginConnection extends RBXObject {
      */
     readonly TargetId: string;
     /**
+     * This `PluginConnectionTargetType` describes the relationship of the target data model to the current one.
+     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: NotReplicated
      *
@@ -16713,15 +16860,24 @@ interface PluginConnection extends RBXObject {
      */
     readonly Type: Enum.PluginConnectionTargetType;
     /**
+     * Binds a callback to this `PluginConnection` to receive messages from `SendMessage()`.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection#BindToMessage)
+     * @param this Encapsulates a connection between the current data model and another for plugin communication.
+     * @param callback A function accepting a string or a buffer which will be called when this `PluginConnection` receives a message.
+     * @returns A `RBXScriptConnection` representing the binding of this callback to the `PluginConnection`. Disconnect it to disconnect this callback from the connection.
      */
     BindToMessage(this: PluginConnection, callbackFunction: Callback): RBXScriptConnection;
     /**
+     * Sends a payload to the remote data model.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection#SendMessage)
+     * @param this Encapsulates a connection between the current data model and another for plugin communication.
+     * @param message The string or buffer to be sent.
      */
     SendMessage(this: PluginConnection, message: unknown): void;
 }
@@ -16803,6 +16959,8 @@ interface VideoSampler extends RBXObject {
     readonly _nominal_VideoSampler: unique symbol;
 }
 /**
+ * Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
+ *
  * - **Tags**: NotCreatable, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput)
@@ -16816,42 +16974,6 @@ interface VirtualInput extends RBXObject {
      * @deprecated
      */
     readonly _nominal_VirtualInput: unique symbol;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
-     */
-    SendKey(this: VirtualInput, isPressed: boolean, keyCode: CastsToEnum<Enum.KeyCode>, isRepeatedKey?: boolean): void;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
-     */
-    SendMouseButton(this: VirtualInput, position: Vector2, button: CastsToEnum<Enum.UserInputType>, isDown: boolean, repeatCount?: number): void;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
-     */
-    SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
-     */
-    SendMousePosition(this: VirtualInput, position: Vector2): void;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
-     */
-    SendPointerAction(this: VirtualInput, position: Vector2, pointerAction: object): void;
-    /**
-     * - **ThreadSafety**: Unsafe
-     *
-     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
-     */
-    SendTextInput(this: VirtualInput, text: string): void;
 }
 /**
  * - **Tags**: NotCreatable, NotReplicated