@rbxts/types 1.0.913 → 1.0.914

package/include/generated/None.d.ts

@@ -145,9 +145,11 @@ interface Services {
     PlayerHydrationService: PlayerHydrationService;
     Players: Players;
     PlayerViewService: PlayerViewService;
+    PluginConnectionService: PluginConnectionService;
     PluginManagementService: PluginManagementService;
     PluginPolicyService: PluginPolicyService;
     PolicyService: PolicyService;
+    ProceduralBehaviorSchedulerService: ProceduralBehaviorSchedulerService;
     ProcessInstancePhysicsService: ProcessInstancePhysicsService;
     ProximityPromptService: ProximityPromptService;
     PublishService: PublishService;
@@ -380,6 +382,7 @@ interface CreatableInstances {
     Folder: Folder;
     ForceField: ForceField;
     Frame: Frame;
+    GeneratedFolder: GeneratedFolder;
     GetTextBoundsParams: GetTextBoundsParams;
     Glue: Glue;
     GroundController: GroundController;
@@ -445,9 +448,11 @@ interface CreatableInstances {
     PointLight: PointLight;
     Pose: Pose;
     PrismaticConstraint: PrismaticConstraint;
+    ProceduralModel: ProceduralModel;
     ProximityPrompt: ProximityPrompt;
     PyramidHandleAdornment: PyramidHandleAdornment;
     RayValue: RayValue;
+    RealtimeMedia: RealtimeMedia;
     RelativeGui: RelativeGui;
     RemoteEvent: RemoteEvent;
     RemoteFunction: RemoteFunction;
@@ -747,6 +752,7 @@ interface Objects extends Instances {
     MLSession: MLSession;
     Object: RBXObject;
     OutputLink: OutputLink;
+    PluginConnection: PluginConnection;
     ScreenshotCapture: ScreenshotCapture;
     TerrainIterateOperation: TerrainIterateOperation;
     TerrainModifyOperation: TerrainModifyOperation;
@@ -754,6 +760,7 @@ interface Objects extends Instances {
     TerrainWriteOperation: TerrainWriteOperation;
     VideoCapture: VideoCapture;
     VideoSampler: VideoSampler;
+    VirtualInput: VirtualInput;
     VoxelBuffer: VoxelBuffer;
     WebStreamClient: WebStreamClient;
 }
@@ -4313,10 +4320,16 @@ interface AssetService extends Instance {
      */
     CreateAssetVersionAsync(this: AssetService, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>, assetId: number, requestParameters?: object): unknown;
     /**
+     * Creates ephemeral, `DataModel`-scoped content from the provided content input.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateDataModelContentAsync)
+     * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
+     * @param content Reference to the input content. Currently, this only supports `Content` wrapping a `EditableMesh` or `EditableImage`.
+     * @param options Optional dictionary containing configuration controls for the created `DataModel` content. Currently no controls are surfaced and this parameter exists for future functionality.
+     * @returns A tuple containing an `CreateContentResult` indicating the success or failure of the request, and the resulting `DataModel`-scoped `Opaque` `Content`.
      */
     CreateDataModelContentAsync(this: AssetService, content: Content, options?: object): unknown;
     /**
@@ -4469,7 +4482,9 @@ interface AssetService extends Instance {
      * -  `Items` — Array of items in the bundle, each with details   represented through the following keys:
      * -  `Id` — Item ID
      * -  `Name` — Item name
-     * -  `Type` — Item type such as `"Asset"` .
+     * -  `Type` — Item type such as `"Asset"`
+     * -  `AssetType` — String representing the `AvatarAssetType`
+     * -  `SupportsHeadShapes` — Whether the asset supports head shape     swapping. Only present if `AssetType` is `"DynamicHead"`.
      */
     GetBundleDetailsAsync(this: AssetService, bundleId: number): BundleInfo;
     /**
@@ -6605,7 +6620,7 @@ interface AudioPlayer extends Instance {
      */
     AutoPlay: boolean;
     /**
-     * Denotes whether this `AudioPlayer` is currently playing.
+     * Denotes whether this `AudioPlayer` is currently playing or planning to play.
      *
      * - **ThreadSafety**: ReadSafe
      *
@@ -6722,6 +6737,8 @@ interface AudioPlayer extends Instance {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Play)
      * @param this Used to play audio assets.
+     * @param atTime A specific time, based on `GetMixerTime`, that this `AudioPlayer` should begin playing at.
+     * @returns If `atTime` was provided, a unique ID, which can be passed to `Cancel()`.
      */
     Play(this: AudioPlayer, atTime?: number): number | undefined;
     /**
@@ -6731,6 +6748,8 @@ interface AudioPlayer extends Instance {
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Stop)
      * @param this Used to play audio assets.
+     * @param atTime A specific time, based on `GetMixerTime`, that this `AudioPlayer` should stop playing at.
+     * @returns If `atTime` was provided, a unique ID, which can be passed to `Cancel()`.
      */
     Stop(this: AudioPlayer, atTime?: number): number | undefined;
     /**
@@ -8224,12 +8243,15 @@ interface AvatarEditorService extends Instance {
      */
     ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
     /**
+     * Returns a copy of the given `HumanoidDescription` that conforms to the platform Avatar rules.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync)
      * @param this A service to support developer Avatar Editors.
-     * @param humanoidDescription
+     * @param humanoidDescription The `HumanoidDescription` to conform.
+     * @returns A new `HumanoidDescription` that conforms to the platform Avatar rules.
      */
     ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
     /**
@@ -8321,10 +8343,14 @@ interface AvatarEditorService extends Instance {
      */
     GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
     /**
+     * Returns an array of head shape names that the `Players.LocalPlayer` owns.
+     *
      * - **ThreadSafety**: Unsafe
      * - **Tags**: Yields
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
+     * @param this A service to support developer Avatar Editors.
+     * @returns An array of strings, each identifying a head shape owned by `Players.LocalPlayer`. Possible values include: `"RobloxClassic"`, `"Blockhead"`, `"Cheeks"`, `"Chiseled"`, `"CoolThing"`, `"EraserHead"`, `"FatHead"`, `"FlatTop"`, `"GoldenKorbloxGeneral"`, `"GoldenMrRobot"`, `"KnightOfChivalry"`, `"KnightOfCourage"`, `"ManHead"`, `"MercilessNinja"`, `"Narrow"`, `"Paragon"`, `"Peabrain"`, `"Perfection"`, `"Roll"`, `"Roundy"`, `"RoxBox"`, `"TheEngineer"`, `"Trim"`, `"WomanHead"`.
      */
     GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
     /**
@@ -8702,7 +8728,7 @@ interface BadgeService extends Instance {
      * @param this Provides information on badges and awards them.
      * @param userId The `UserId` of the player to check for ownership of the specified badges.
      * @param badgeIds The list of IDs of the badges to check ownership of. Maximum length of 10.
-     * @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list.
+     * @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list. Some badge IDs may be omitted if the user with the target `userId` has not recently been in the server and the badge IDs are not associated with the requesting experience.
      */
     CheckUserBadgesAsync(this: BadgeService, userId: number, badgeIds: Array<unknown>): Array<unknown>;
     /**
@@ -9271,6 +9297,12 @@ interface RootImportData extends BaseImportData {
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#MergeMeshes)
      */
     MergeMeshes: boolean;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#PhysicalConstraintType)
+     */
+    PhysicalConstraintType: Enum.PhysicalConstraintType;
     /**
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: NotReplicated
@@ -12729,8 +12761,6 @@ interface AnimationConstraint extends Constraint {
      */
     readonly _nominal_AnimationConstraint: unique symbol;
     /**
-     * **Deprecated:**
-     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: Hidden, NotReplicated
      *
@@ -12740,8 +12770,6 @@ interface AnimationConstraint extends Constraint {
      */
     readonly C0: CFrame;
     /**
-     * **Deprecated:**
-     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: Hidden, NotReplicated
      *
@@ -12775,8 +12803,6 @@ interface AnimationConstraint extends Constraint {
      */
     MaxTorque: number;
     /**
-     * **Deprecated:**
-     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: Hidden, NotReplicated
      *
@@ -12786,8 +12812,6 @@ interface AnimationConstraint extends Constraint {
      */
     readonly Part0: BasePart | undefined;
     /**
-     * **Deprecated:**
-     *
      * - **ThreadSafety**: ReadSafe
      * - **Tags**: Hidden, NotReplicated
      *
@@ -17528,6 +17552,25 @@ interface Folder extends Instance {
      */
     readonly _nominal_Folder: unique symbol;
 }
+/**
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder)
+ */
+interface GeneratedFolder extends Folder {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_GeneratedFolder: unique symbol;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
+     */
+    SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
+}
 /**
  * Protects a `Humanoid` from taking damage dealt through the `Humanoid:TakeDamage()` method and protects `BaseParts` from having their joints broken due to an `Explosion`.
  *
@@ -24345,6 +24388,8 @@ interface HumanoidDescription extends Instance {
      */
     ShouldersAccessory: string;
     /**
+     * When `true`, disables facial animations on a Dynamic Head, displaying a static mood pose instead. Defaults to `false`.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#StaticFacialAnimation)
@@ -28081,6 +28126,8 @@ interface MLService extends Instance {
     CreateSessionAsync(this: MLService, assetId: string): MLSession;
 }
 /**
+ * Describes the appearance of a makeup item for the `HumanoidDescription`.
+ *
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
  */
 interface MakeupDescription extends Instance {
@@ -28093,34 +28140,44 @@ interface MakeupDescription extends Instance {
      */
     readonly _nominal_MakeupDescription: unique symbol;
     /**
+     * The asset ID that should be applied when applying this `MakeupDescription`.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#AssetId)
      */
     AssetId: number;
     /**
+     * A reference to the `Instance` that should be used when applying this `MakeupDescription`.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Instance)
      */
     Instance: Instance | undefined;
     /**
+     * The `MakeupType` of the makeup item referred to by this description.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#MakeupType)
      */
     MakeupType: Enum.MakeupType;
     /**
+     * The layering sort order for the makeup item.
+     *
      * - **ThreadSafety**: ReadSafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Order)
      */
     Order: number;
     /**
+     * Returns the applied makeup `Instance`.
+     *
      * - **ThreadSafety**: Unsafe
      *
      * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#GetAppliedInstance)
-     * @param this
+     * @param this Describes the appearance of a makeup item for the `HumanoidDescription`.
      */
     GetAppliedInstance(this: MakeupDescription): Instance | undefined;
 }
@@ -32915,6 +32972,51 @@ interface Tool extends BackpackItem {
      */
     readonly Unequipped: RBXScriptSignal<() => void>;
 }
+/**
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel)
+ */
+interface ProceduralModel extends Model {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_ProceduralModel: unique symbol;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#GenerationError)
+     */
+    readonly GenerationError: string;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Generator)
+     */
+    Generator: ModuleScript | undefined;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Size)
+     */
+    Size: Vector3;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
+     */
+    ForceGeneration(this: ProceduralModel): boolean;
+    /**
+     * - **ThreadSafety**: Unsafe
+     * - **Tags**: Yields
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#WaitForGenerationAsync)
+     */
+    WaitForGenerationAsync(this: ProceduralModel): boolean;
+}
 /**
  * Base class for handling physics simulation and 3D spatial queries.
  *
@@ -36467,6 +36569,21 @@ interface PluginCapabilities extends Instance {
      */
     readonly _nominal_PluginCapabilities: unique symbol;
 }
+/**
+ * - **Tags**: NotCreatable, Service, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService)
+ */
+interface PluginConnectionService extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_PluginConnectionService: unique symbol;
+}
 /**
  * - **Tags**: NotCreatable, Service, NotReplicated
  *
@@ -36915,6 +37032,21 @@ interface SunRaysEffect extends PostEffect {
      */
     Spread: number;
 }
+/**
+ * - **Tags**: NotCreatable, Service, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralBehaviorSchedulerService)
+ */
+interface ProceduralBehaviorSchedulerService extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_ProceduralBehaviorSchedulerService: unique symbol;
+}
 /**
  * - **Tags**: NotCreatable, Service
  *
@@ -37317,6 +37449,75 @@ interface RTAnimationTracker extends Instance {
      */
     readonly TrackerPrompt: RBXScriptSignal<(prompt: Enum.TrackerPromptEvent) => void>;
 }
+/**
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia)
+ */
+interface RealtimeMedia extends Instance {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_RealtimeMedia: unique symbol;
+    /**
+     * - **ThreadSafety**: ReadSafe
+     * - **Tags**: NotReplicated
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#IsConnected)
+     */
+    readonly IsConnected: boolean;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#Disconnect)
+     */
+    Disconnect(this: RealtimeMedia): void;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetConnectedWires)
+     */
+    GetConnectedWires(this: RealtimeMedia, pin: string): Array<Instance>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetInputPins)
+     */
+    GetInputPins(this: RealtimeMedia): Array<unknown>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#GetOutputPins)
+     */
+    GetOutputPins(this: RealtimeMedia): Array<unknown>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#SendMessage)
+     */
+    SendMessage(this: RealtimeMedia, message: string, binary: boolean): boolean;
+    /**
+     * - **ThreadSafety**: Unsafe
+     * - **Tags**: Yields
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#ConnectAsync)
+     */
+    ConnectAsync(this: RealtimeMedia, serverUrl: string, connectParams?: object): boolean;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#OnMessage)
+     */
+    readonly OnMessage: RBXScriptSignal<(message: string, binary: boolean) => void>;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#WiringChanged)
+     */
+    readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
+}
 /**
  * A service that provides an interface for you to manage and display personalized content recommendations.
  *
@@ -38440,6 +38641,18 @@ interface ScriptContext extends Instance {
      * @deprecated
      */
     readonly _nominal_ScriptContext: unique symbol;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
+     */
+    EnableCoverage(this: ScriptContext, instance: Instance): void;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
+     */
+    GetCoverageStats(this: ScriptContext): Array<unknown>;
     /**
      * Fired when an error occurs.
      *
@@ -41729,6 +41942,18 @@ interface StudioTestService extends Instance {
      * @deprecated
      */
     readonly _nominal_StudioTestService: unique symbol;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#AddPlayers)
+     */
+    AddPlayers(this: StudioTestService, numPlayers: number): void;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#CanLeaveTest)
+     */
+    CanLeaveTest(this: StudioTestService): boolean;
     /**
      * - **ThreadSafety**: Unsafe
      *
@@ -41745,6 +41970,12 @@ interface StudioTestService extends Instance {
      * @returns Arguments passed to the test, or `nil`.
      */
     GetTestArgs(this: StudioTestService): unknown;
+    /**
+     * - **ThreadSafety**: Unsafe
+     *
+     * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#LeaveTest)
+     */
+    LeaveTest(this: StudioTestService): void;
 }
 /**
  * - **Tags**: NotCreatable, Service, NotReplicated
@@ -49013,6 +49244,21 @@ interface OutputLink extends RBXObject {
      */
     readonly _nominal_OutputLink: unique symbol;
 }
+/**
+ * - **Tags**: NotCreatable, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection)
+ */
+interface PluginConnection extends RBXObject {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_PluginConnection: unique symbol;
+}
 /**
  * - **Tags**: NotCreatable, NotReplicated
  *
@@ -49171,6 +49417,21 @@ interface VideoSampler extends RBXObject {
      */
     GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
 }
+/**
+ * - **Tags**: NotCreatable, NotReplicated
+ *
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput)
+ */
+interface VirtualInput extends RBXObject {
+    /**
+     * **DO NOT USE!**
+     *
+     * This field exists to force TypeScript to recognize this as a nominal type
+     * @hidden
+     * @deprecated
+     */
+    readonly _nominal_VirtualInput: unique symbol;
+}
 /**
  * - **Tags**: NotCreatable, NotReplicated
  *