@rbxts/types 1.0.896 → 1.0.902

package/include/generated/PluginSecurity.d.ts

@@ -98,6 +98,7 @@ interface Services {
     IncrementalPatchBuilder: IncrementalPatchBuilder;
     InsertService: InsertService;
     InstanceExtensionsService: InstanceExtensionsService;
+    InstanceFileSyncService: InstanceFileSyncService;
     InternalSyncService: InternalSyncService;
     IXPService: IXPService;
     JointsService: JointsService;
@@ -822,7 +823,7 @@ interface AnimationNode extends RBXObject {
     readonly _nominal_AnimationNode: unique symbol;
 }
 /**
- * A class which defines a piece of content, such as a screnshot or video, taken in-experience.
+ * A class which defines a piece of content, such as a screenshot or video, taken in-experience.
  *
  * - **Tags**: NotCreatable, NotReplicated
  *
@@ -873,6 +874,8 @@ interface VideoCapture extends Capture {
     readonly _nominal_VideoCapture: unique symbol;
 }
 /**
+ * A snapshot of configuration values at a given version. Can be player-specific.
+ *
  * - **Tags**: NotCreatable, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
@@ -3405,6 +3408,8 @@ interface CommerceService extends Instance {
     readonly _nominal_CommerceService: unique symbol;
 }
 /**
+ * An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
+ *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
  */
 interface CompositeValueCurve extends Instance {
@@ -3418,6 +3423,8 @@ interface CompositeValueCurve extends Instance {
     readonly _nominal_CompositeValueCurve: unique symbol;
 }
 /**
+ * A game service that gives access to in-experience configuration with updates in real time.
+ *
  * - **Tags**: NotCreatable, Service, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
@@ -3542,6 +3549,8 @@ interface AngularVelocity extends Constraint {
 /**
  * Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
  *
+ * - **Tags**: NotBrowsable
+ *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
  */
 interface AnimationConstraint extends Constraint {
@@ -7199,6 +7208,45 @@ interface InstanceExtensionsService extends Instance {
      */
     readonly _nominal_InstanceExtensionsService: unique symbol;
 }
+/**
+ * - **Tags**: NotCreatable, Service, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService)
+ */
+interface InstanceFileSyncService extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_InstanceFileSyncService: unique symbol;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetAllInstances)
+     */
+    GetAllInstances(this: InstanceFileSyncService): Array<Instance>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetStatus)
+     */
+    GetStatus(this: InstanceFileSyncService, instance: Instance): Enum.InstanceFileSyncStatus;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetSyncedInstance)
+     */
+    GetSyncedInstance(this: InstanceFileSyncService, filePath: string): Instance | undefined;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#StatusChanged)
+     */
+    readonly StatusChanged: RBXScriptSignal<(instance: Instance, status: Enum.InstanceFileSyncStatus) => void>;
+}
 /**
  * - **Tags**: NotReplicated
  *
@@ -10197,11 +10245,11 @@ interface Plugin extends Instance {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Activate)
      * @param this
-     * @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If true, a `PluginMouse` can be retrieved via `Plugin:GetMouse()`.
+     * @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If `true`, a `PluginMouse` can be retrieved via `GetMouse()`.
      */
     Activate(this: Plugin, exclusiveMouse: boolean): void;
     /**
-     * Creates a `PluginAction` which is an object that represents a generic performable action in Roblox Studio, with no directly associated `Toolbar` or `Button`.
+     * Creates a `PluginAction` which represents a generic performable action in Studio with no directly‑associated `PluginToolbarButton`.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10222,8 +10270,8 @@ interface Plugin extends Instance {
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginMenu)
      * @param this
      * @param id Unique ID for the menu.
-     * @param title The text to be displayed when used as a sub menu.
-     * @param icon The icon to be displayed when used as a sub menu.
+     * @param title The text to be displayed when used as a submenu.
+     * @param icon The icon to be displayed when used as a submenu.
      */
     CreatePluginMenu(this: Plugin, id: string, title?: string, icon?: string): PluginMenu;
     /**
@@ -10246,7 +10294,7 @@ interface Plugin extends Instance {
      */
     Deactivate(this: Plugin): void;
     /**
-     * Returns the `JointCreationMode` the user has set in Studio under the Model tab.
+     * Returns the `JointCreationMode` the user has set in Studio's toolbar.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10297,6 +10345,8 @@ interface Plugin extends Instance {
      */
     GetStudioUserId(this: Plugin): number;
     /**
+     * Intersects the given parts and returns the resulting `IntersectOperation`.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Intersect)
@@ -10305,7 +10355,7 @@ interface Plugin extends Instance {
      */
     Intersect(this: Plugin, objects: Array<Instance>): Instance | undefined;
     /**
-     * Returns true if this plugin is currently active, after having been activated via the `Plugin:Activate()` function.
+     * Returns `true` if this plugin is currently active, after having been activated via the `Activate()` function.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10315,7 +10365,7 @@ interface Plugin extends Instance {
      */
     IsActivated(this: Plugin): boolean;
     /**
-     * Returns true if this plugin is currently active with an exclusive mouse, after having been activated via the `Plugin:Activate()` function.
+     * Returns `true` if this plugin is currently active with an exclusive mouse.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10325,7 +10375,7 @@ interface Plugin extends Instance {
      */
     IsActivatedWithExclusiveMouse(this: Plugin): boolean;
     /**
-     * Negates the given parts and returns the resulting NegateOperations.
+     * Negates the given parts and returns the resulting `NegateOperations`.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10381,7 +10431,7 @@ interface Plugin extends Instance {
      */
     SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): void;
     /**
-     * Separates the given UnionOperations and returns the resulting parts.
+     * Separates the given `UnionOperations` and returns the resulting parts.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10412,7 +10462,7 @@ interface Plugin extends Instance {
      */
     StartDrag(this: Plugin, dragData: object): void;
     /**
-     * Unions the given parts and returns the resulting UnionOperation.
+     * Unions the given parts and returns the resulting `UnionOperation`.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10422,6 +10472,8 @@ interface Plugin extends Instance {
      */
     Union(this: Plugin, objects: Array<BasePart>): UnionOperation;
     /**
+     * **Deprecated:** This method has been superseded by `CreateDockWidgetPluginGuiAsync()`.
+     *
      * Creates a `DockWidgetPluginGui` given a `DockWidgetPluginGuiInfo`.
      *
      * - **ThreadSafety**: Unsafe
@@ -10436,14 +10488,21 @@ interface Plugin extends Instance {
      */
     CreateDockWidgetPluginGui(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
     /**
+     * Creates a `DockWidgetPluginGui` given a `DockWidgetPluginGuiInfo`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync)
+     * @param this
+     * @param pluginGuiId A unique and consistent identifier used to storing the widget's dock state and other internal details.
+     * @param dockWidgetPluginGuiInfo Describes the `DockWidgetPluginGui` to create (initial state, size, etc).
      */
     CreateDockWidgetPluginGuiAsync(this: Plugin, pluginGuiId: string, dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo): DockWidgetPluginGui;
     /**
-     * Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
+     * **Deprecated:**
+     *
+     * Prompts the user to open a `.fbx` animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
      *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
@@ -10457,14 +10516,21 @@ interface Plugin extends Instance {
      */
     ImportFbxAnimation(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
     /**
+     * Prompts the user to open a `.fbx` animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync)
+     * @param this
+     * @param rigModel
+     * @param isR15
      */
     ImportFbxAnimationAsync(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
     /**
-     * Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
+     * **Deprecated:**
+     *
+     * Prompts the user to open a `.fbx` file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
      *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
@@ -10477,14 +10543,18 @@ interface Plugin extends Instance {
      */
     ImportFbxRig(this: Plugin, isR15?: boolean): Model;
     /**
+     * Prompts the user to open a `.fbx` file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync)
+     * @param this
+     * @param isR15
      */
     ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
     /**
-     * Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
+     * Opens a window in Roblox Studio which prompts the user to select an asset based on the `assetType` specified.
      *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
@@ -10495,14 +10565,20 @@ interface Plugin extends Instance {
      */
     PromptForExistingAssetId(this: Plugin, assetType: string): number;
     /**
+     * Opens a window in Roblox Studio which prompts the user to select an asset based on the `assetType` specified.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync)
+     * @param this
+     * @param assetType
      */
     PromptForExistingAssetIdAsync(this: Plugin, assetType: string): number;
     /**
-     * Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
+     * **Deprecated:**
+     *
+     * Prompts the user to save their current selection with the specified file name.
      *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
@@ -10515,10 +10591,14 @@ interface Plugin extends Instance {
      */
     PromptSaveSelection(this: Plugin, suggestedFileName?: string): boolean;
     /**
+     * Prompts the user to save their current selection with the specified file name.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync)
+     * @param this
+     * @param suggestedFileName
      */
     PromptSaveSelectionAsync(this: Plugin, suggestedFileName?: string): boolean;
     /**
@@ -10553,7 +10633,7 @@ interface PluginAction extends Instance {
      */
     readonly _nominal_PluginAction: unique symbol;
     /**
-     * Fires when the action is triggered. This can be done by either activating the action from the Quick Access Toolbar, or by using the keyboard shortcut that was bound to it.
+     * Fires when the action is triggered.
      *
      * - **ThreadSafety**: Unsafe
      *
@@ -10712,7 +10792,7 @@ interface PluginMenu extends Instance {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddMenu)
      * @param this A context menu that can be shown in Studio. Displays a list of `PluginActions` and supports submenus.
-     * @param menu The menu to add as a sub menu. Uses its `PluginMenu.Title` and `PluginMenu.Icon` to display.
+     * @param menu The menu to add as a submenu. Uses its `Title` and `Icon` to display.
      */
     AddMenu(this: PluginMenu, menu: PluginMenu): void;
     /**
@@ -10722,7 +10802,7 @@ interface PluginMenu extends Instance {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddNewAction)
      * @param this A context menu that can be shown in Studio. Displays a list of `PluginActions` and supports submenus.
-     * @param actionId Must be a unique string that identifies this PluginAction from others.
+     * @param actionId Must be a unique string that identifies this `PluginAction` from others.
      * @param text The text to be displayed.
      * @param icon The icon to be displayed.
      * @returns The created `PluginAction`.
@@ -10796,8 +10876,8 @@ interface PluginToolbar extends Instance {
      * @param this
      * @param buttonId A unique button ID.
      * @param tooltip The text displayed in the tooltip shown when a user hovers over the button.
-     * @param iconname The asset ID (e.g. rbxassetid://1507949215) of the icon displayed in the button.
-     * @param text Text displayed under the button icon. Optional. If this field is not provided, the **ID** will be used instead.
+     * @param iconname The asset ID of the icon displayed in the button.
+     * @param text Optional text displayed under the button icon.
      * @returns The created `PluginToolbarButton` instance.
      */
     CreateButton(this: PluginToolbar, buttonId: string, tooltip: string, iconname: string, text?: string): PluginToolbarButton;
@@ -12818,7 +12898,7 @@ interface SoundGroup extends Instance {
     readonly _nominal_SoundGroup: unique symbol;
 }
 /**
- * A service that determines various aspects of how `Sounds` play in the experience.
+ * A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
  *
  * - **Tags**: NotCreatable, Service
  *
@@ -12834,6 +12914,8 @@ interface SoundService extends Instance {
      */
     readonly _nominal_SoundService: unique symbol;
     /**
+     * Determines whether the default character sounds will use instances in the advanced audio system vs. `Sounds`.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
@@ -12848,19 +12930,23 @@ interface SoundService extends Instance {
      */
     DefaultListenerLocation: Enum.ListenerLocation;
     /**
+     * Opens the attenuation curve editor in Studio for the provided `AudioEmitter` or `AudioListener` instances.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenAttenuationCurveEditor)
-     * @param this A service that determines various aspects of how `Sounds` play in the experience.
-     * @param selectedCurveObjects
+     * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
+     * @param selectedCurveObjects A list of `AudioEmitters` or `AudioListeners`.
      */
     OpenAttenuationCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
     /**
+     * Opens the directional curve editor in Studio for the provided `AudioEmitter` or `AudioListener` instances.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenDirectionalCurveEditor)
-     * @param this A service that determines various aspects of how `Sounds` play in the experience.
-     * @param selectedCurveObjects
+     * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
+     * @param selectedCurveObjects A list of `AudioEmitters` or `AudioListeners`.
      */
     OpenDirectionalCurveEditor(this: SoundService, selectedCurveObjects: Array<Instance>): void;
 }
@@ -13408,6 +13494,8 @@ interface StudioService extends Instance {
      */
     GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
     /**
+     * **Deprecated:**
+     *
      * Prompts the current Studio user to select one file to add as a `File`.
      *
      * - **ThreadSafety**: Unsafe
@@ -13422,13 +13510,20 @@ interface StudioService extends Instance {
      */
     PromptImportFile(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
     /**
+     * Prompts the current Studio user to select one file to add as a `File`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFileAsync)
+     * @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
+     * @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
+     * @returns The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).
      */
     PromptImportFileAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Instance | undefined;
     /**
+     * **Deprecated:**
+     *
      * Prompts the current Studio user to select files to add as `Files`.
      *
      * - **ThreadSafety**: Unsafe
@@ -13443,14 +13538,21 @@ interface StudioService extends Instance {
      */
     PromptImportFiles(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
     /**
+     * Prompts the current Studio user to select files to add as `Files`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFilesAsync)
+     * @param this Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
+     * @param fileTypeFilter A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.
+     * @returns The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).
      */
     PromptImportFilesAsync(this: StudioService, fileTypeFilter?: Array<unknown>): Array<Instance>;
 }
 /**
+ * Service allowing plugins to automate and customize Test and Run mode testing.
+ *
  * - **Tags**: NotCreatable, Service, NotReplicated
  *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService)
@@ -13469,6 +13571,9 @@ interface StudioTestService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecutePlayModeAsync)
+     * @param this Service allowing plugins to automate and customize Test and Run mode testing.
+     * @param args Argument passed to the test session, or `nil`.
+     * @returns Value passed from `StudioTestService:EndTest()`, or `nil`.
      */
     ExecutePlayModeAsync(this: StudioTestService, args: unknown): unknown;
     /**
@@ -13476,6 +13581,9 @@ interface StudioTestService extends Instance {
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecuteRunModeAsync)
+     * @param this Service allowing plugins to automate and customize Test and Run mode testing.
+     * @param args Argument passed to the test session, or `nil`.
+     * @returns Value passed from `StudioTestService:EndTest()`, or `nil`.
      */
     ExecuteRunModeAsync(this: StudioTestService, args: unknown): unknown;
 }
@@ -14060,7 +14168,9 @@ interface TestService extends Instance {
      */
     readonly _nominal_TestService: unique symbol;
     /**
-     * Runs scripts which are parented to TestService.
+     * **Deprecated:**
+     *
+     * Runs scripts which are parented to `TestService`.
      *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
@@ -14072,10 +14182,13 @@ interface TestService extends Instance {
      */
     Run(this: TestService): void;
     /**
+     * Runs scripts which are parented to `TestService`.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RunAsync)
+     * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
      */
     RunAsync(this: TestService): void;
 }
@@ -14210,7 +14323,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
     readonly _nominal_ChatWindowConfiguration: unique symbol;
 }
 /**
- * Immutable data object representing a text chat message.
+ * A data object representing a text chat message.
  *
  * - **Tags**: NotCreatable
  *