@rbxts/types 1.0.553 → 1.0.557

package/include/generated/None.d.ts

@@ -92,6 +92,7 @@ interface Services {
 	TeleportService: TeleportService;
 	TemporaryCageMeshProvider: TemporaryCageMeshProvider;
 	TemporaryScriptService: TemporaryScriptService;
+	TextBoxService: TextBoxService;
 	TextChatService: TextChatService;
 	TextService: TextService;
 	ToastNotificationService: ToastNotificationService;
@@ -187,6 +188,7 @@ interface CreatableInstances {
 	Glue: Glue;
 	Handles: Handles;
 	Hat: Hat;
+	HiddenSurfaceRemovalAsset: HiddenSurfaceRemovalAsset;
 	Highlight: Highlight;
 	HingeConstraint: HingeConstraint;
 	Hole: Hole;
@@ -1951,7 +1953,7 @@ interface AssetImportService extends Instance {
 	readonly _nominal_AssetImportService: unique symbol;
 	readonly ProgressUpdate: RBXScriptSignal<(progressRatio: number) => void>;
 	readonly SettingsChanged: RBXScriptSignal<(property: string) => void>;
-	readonly UploadFinished: RBXScriptSignal<(succeeded: boolean) => void>;
+	readonly UploadFinished: RBXScriptSignal<(succeeded: boolean, errorMap: object) => void>;
 }
 
 interface AssetManagerService extends Instance {
@@ -6961,9 +6963,9 @@ interface RigidConstraint extends Constraint {
 	 */
 	readonly _nominal_RigidConstraint: unique symbol;
 	/**
-	 * Tags: NotBrowsable
+	 * Tags: ReadOnly, NotReplicated, NotBrowsable
 	 */
-	Broken: boolean;
+	readonly Broken: boolean;
 	/**
 	 * Tags: NotBrowsable
 	 */
@@ -10212,7 +10214,7 @@ interface GroupService extends Instance {
 	 * 
 	 * A boolean indicating if this is the player's primary group
 	 * 
-	 * IsInClan
+	 * ### IsInClan
 	 * 
 	 * A boolean indicating if the player is in this group's clan
 	 * 
@@ -10962,7 +10964,7 @@ interface CanvasGroup extends GuiObject {
 	 */
 	readonly _nominal_CanvasGroup: unique symbol;
 	GroupColor: Color3;
-	Transparency: number;
+	GroupTransparency: number;
 }
 
 /** Frame is a [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject) that renders as a plain rectangle with no other content. They are the simplest concrete example of a [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject), as they provide very little additional functionality (`Frame.FrameStyle`). Despite this, Frames are useful as containers for other [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject)s, such as [TextLabel](https://developer.roblox.com/en-us/api-reference/class/TextLabel), [ImageLabel](https://developer.roblox.com/en-us/api-reference/class/ImageLabel). The key benefit to using a Frame over a [Folder](https://developer.roblox.com/en-us/api-reference/class/Folder) as a container object is the ability to further manipulate the `GuiObject.Size` and `GuiObject.Position` of any descendant [GuiObject](https://developer.roblox.com/en-us/api-reference/class/GuiObject)s. */
@@ -13360,6 +13362,17 @@ interface HeightmapImporterService extends Instance {
 	readonly _nominal_HeightmapImporterService: unique symbol;
 }
 
+interface HiddenSurfaceRemovalAsset extends Instance {
+	/**
+	 * **DO NOT USE!**
+	 *
+	 * This field exists to force TypeScript to recognize this as a nominal type
+	 * @hidden
+	 * @deprecated
+	 */
+	readonly _nominal_HiddenSurfaceRemovalAsset: unique symbol;
+}
+
 interface Highlight extends Instance {
 	/**
 	 * **DO NOT USE!**
@@ -17755,11 +17768,11 @@ interface JointsService extends Instance {
 	 */
 	CreateJoinAfterMoveJoints(this: JointsService): void;
 	/**
-	 * Sets the PVInstance that will be connected with the target PVInstance specified by [SetJoinAfterMoveTarget](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveTarget "SetJoinAfterMoveTarget").
+	 * Sets the PVInstance that will be connected with the target PVInstance specified by [JointsService:SetJoinAfterMoveTarget](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveTarget).
 	 */
 	SetJoinAfterMoveInstance(this: JointsService, joinInstance: PVInstance): void;
 	/**
-	 * Sets the PVInstance that will be connected with the PVInstance specified by [SetJoinAfterMoveInstance](https://developer.roblox.com/api-reference/function/JointsService/SetJoinAfterMoveInstance "SetJoinAfterMoveInstance").
+	 * Sets the PVInstance that will be connected with the PVInstance specified by [JointsService:SetJoinAfterMoveInstance](https://developer.roblox.com/en-us/api-reference/function/JointsService/SetJoinAfterMoveInstance).
 	 */
 	SetJoinAfterMoveTarget(this: JointsService, joinTarget: PVInstance): void;
 	/**
@@ -20439,8 +20452,11 @@ interface MaterialService extends Instance {
 	 */
 	readonly _nominal_MaterialService: unique symbol;
 	ClearOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
+	ClearOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): void;
 	GetOverridePartMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
+	GetOverrideTerrainMaterial(this: MaterialService, material: CastsToEnum<Enum.Material>): MaterialVariant;
 	SetOverridePartMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
+	SetOverrideTerrainMaterial(this: MaterialService, materialVariant: MaterialVariant): void;
 }
 
 interface MaterialVariant extends Instance {
@@ -20452,6 +20468,7 @@ interface MaterialVariant extends Instance {
 	 * @deprecated
 	 */
 	readonly _nominal_MaterialVariant: unique symbol;
+	MaterialPattern: Enum.MaterialPattern;
 	StudsPerTile: number;
 }
 
@@ -23210,7 +23227,7 @@ interface Model extends PVInstance {
 	TranslateBy(this: Model, delta: Vector3): void;
 }
 
-/** Actor */
+/** Actor Class */
 interface Actor extends Model {
 	/**
 	 * **DO NOT USE!**
@@ -24159,6 +24176,11 @@ interface ParticleEmitter extends Instance {
 	 * If you want no particles to render, you should call [ParticleEmitter:Clear](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Clear) to clear any existing particles. You can use [ParticleEmitter:Emit](https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit) on disabled [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter)s and they will still emit and render particles.
 	 */
 	Enabled: boolean;
+	FlipbookFramerate: NumberRange;
+	FlipbookIncompatible: string;
+	FlipbookLayout: Enum.ParticleFlipbookLayout;
+	FlipbookMode: Enum.ParticleFlipbookMode;
+	FlipbookStartRandom: boolean;
 	/**
 	 * The Lifetime property defines the maximum and minimum ages a newly emit particle will. When a particle is emit, a random lifetime is chosen uniformly. Lifetimes are stored on a per-particle basis, so if this value is changed, existing particles will stay “alive” until their randomly chosen lifetime is lived. The bounds for this property should be in the range \[0, 20\]. By default, [ParticleEmitter](https://developer.roblox.com/en-us/api-reference/class/ParticleEmitter)s will have a lifetime of 5 to 10 seconds. A lifetime of 0 will prevent particles from being emit in the first place.
 	 * 
@@ -24648,19 +24670,19 @@ interface PhysicsService extends Instance {
 	 * This function will throw a runtime error in the following circumstances:
 	 * 
 	 * *   The specified group does not exist.
-	 * *   The specified part is not a BasePart.Returns whether the part is in the collision group.
+	 * *   The specified part is not a BasePart.
 	 */
 	CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
 	/**
 	 * Sets the collision status between two groups.
 	 * 
-	 * This function will throw an error if either of the groups do not exist.Sets the collision status between two groups.
+	 * This function will throw an error if either of the groups do not exist.
 	 */
 	CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): void;
 	/**
 	 * Returns whether the two specified collision groups will collide.
 	 * 
-	 * This function will throw an error if either of the groups do not exist.Returns whether the two groups will collide.
+	 * This function will throw an error if either of the groups do not exist.
 	 */
 	CollisionGroupsAreCollidable(this: PhysicsService, name1: string, name2: string): boolean;
 	/**
@@ -24676,7 +24698,7 @@ interface PhysicsService extends Instance {
 	/**
 	 * Returns the name of the collision group with the corresponding id. This function will return nil if the group with the corresponding id has not been named.
 	 * 
-	 * This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroupsReturns the name of the group with the corresponding id.
+	 * This function will throw an error if the id is not in the range of 0 <= id < maxCollisionGroups
 	 */
 	GetCollisionGroupName(this: PhysicsService, name: number): string;
 	/**
@@ -24719,7 +24741,7 @@ interface PhysicsService extends Instance {
 	 * This function will throw a runtime error in the following circumstances:
 	 * 
 	 * *   The name “Default” is provided.
-	 * *   The function is called from a client.Removes the collision group with the given name.
+	 * *   The function is called from a client.
 	 */
 	RemoveCollisionGroup(this: PhysicsService, name: string): void;
 	/**
@@ -24730,7 +24752,7 @@ interface PhysicsService extends Instance {
 	 * This function will throw a runtime error in the following circumstances:
 	 * 
 	 * *   Invalid or empty name provided for either argument.
-	 * *   The function is called from a client.Renames specified collision group.
+	 * *   The function is called from a client.
 	 */
 	RenameCollisionGroup(this: PhysicsService, from: string, to: string): void;
 	/**
@@ -26659,7 +26681,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
 	 * 
 	 * Since this function is used to communicate from the server to the client, it will only work when used in a [Script](https://developer.roblox.com/en-us/api-reference/class/Script).
 	 * 
-	 * The functionality of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
+	 * The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
+	 * 
+	 * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
 	 * 
 	 * Note
 	 * ----
@@ -26672,6 +26696,8 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
 	 * 
 	 * Since this function is used for communication from server to client, so it will only work when used by a server-side [Script](https://developer.roblox.com/en-us/api-reference/class/Script). For client-to-server communication (the other direction), use [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer). Direct client-to-client communication not possible on Roblox; however, it can be simulated using a [Script](https://developer.roblox.com/en-us/api-reference/class/Script) that relays information received through some other means, such as [FireServer](https://developer.roblox.com/en-us/api-reference/function/RemoteEvent/FireServer).
 	 * 
+	 * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
+	 * 
 	 * See also
 	 * --------
 	 * 
@@ -26689,7 +26715,9 @@ interface RemoteEvent<T extends Callback = Callback> extends Instance {
 	 * 
 	 * When firing from the client note that nothing has to be passed in by default (unlike firing to the client from the server - where the player is passed in).
 	 * 
-	 * The functionality of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
+	 * The behavior of this function, as well as other [RemoteEvent](https://developer.roblox.com/en-us/api-reference/class/RemoteEvent) and [RemoteFunction](https://developer.roblox.com/en-us/api-reference/class/RemoteFunction) events and functions, is well documented in [this](https://developer.roblox.com/articles/Remote-Functions-and-Events) article.
+	 * 
+	 * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
 	 */
 	FireServer(this: RemoteEvent, ...args: Parameters<T>): void;
 	/**
@@ -26746,7 +26774,9 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
 	 * Warning
 	 * -------
 	 * 
-	 * If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it does stop the execution of other code.
+	 * If a client disconnects or leaves the game while it is being invoked from the server, the InvokeClient function will error. It is therefore recommended to wrap this function in a pcall so it doesn't stop the execution of other code.
+	 * 
+	 * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
 	 * Tags: Yields
 	 */
 	InvokeClient(this: RemoteFunction, player: Player, ...args: Parameters<T>): unknown;
@@ -26763,6 +26793,8 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
 	 * ----
 	 * 
 	 * When handling the invocation from the client note that nothing has to be passed in by default (unlike invoking the server where the player is passed in).
+	 * 
+	 * There are limitations on the kinds of data that can be passed between the client and server. For more information, see [Parameter Limitations](https://developer.roblox.com/articles/Remote-Functions-and-Events#parameter-limitations).
 	 * Tags: Yields
 	 */
 	InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
@@ -30576,6 +30608,17 @@ interface TerrainRegion extends Instance {
 	readonly SizeInCells: Vector3;
 }
 
+interface TextBoxService extends Instance {
+	/**
+	 * **DO NOT USE!**
+	 *
+	 * This field exists to force TypeScript to recognize this as a nominal type
+	 * @hidden
+	 * @deprecated
+	 */
+	readonly _nominal_TextBoxService: unique symbol;
+}
+
 interface TextChannel extends Instance {
 	/**
 	 * **DO NOT USE!**
@@ -34263,6 +34306,9 @@ interface Vector3Curve extends Instance {
 	 * @deprecated
 	 */
 	readonly _nominal_Vector3Curve: unique symbol;
+	/**
+	 * Samples the 3 FloatCurves (X, Y, Z) at the time passed as argument. Returns the 3 samples as a tuple of 3 numbers. If a channel curve is missing or no key is found in the curve the channel is evaluated as nil.
+	 */
 	GetValueAtTime(this: Vector3Curve, time: number): unknown;
 	/**
 	 * Returns the FloatCurve controlling the X channel. It is the first child instance of type FloatCurve named `X`. If none is found an empty FloatCurve is created.

package/include/generated/PluginSecurity.d.ts

@@ -3394,6 +3394,7 @@ interface Studio extends Instance {
 	readonly ["Show Light Guides"]: boolean;
 	readonly ["Show Navigation Areas"]: boolean;
 	["Show Navigation Mesh"]: boolean;
+	readonly ["Show Pathfinding Links"]: boolean;
 	["Show Plugin GUI Service in Explorer"]: boolean;
 	["Show QT warnings in output"]: boolean;
 	["Show Whitespace"]: boolean;
@@ -3615,6 +3616,7 @@ interface StudioService extends Instance {
 	AnimationIdSelected(this: StudioService, id: number): void;
 	ConvertToPackageUpload(this: StudioService, uploadUrl: string): void;
 	CopyToClipboard(this: StudioService, stringToCopy: string): void;
+	DEPRECATED_SetDocumentDisplayName(this: StudioService, newName: string): void;
 	EmitPlacePublishedSignal(this: StudioService): void;
 	GetBadgeConfigureUrl(this: StudioService, badgeId: number): string;
 	GetBadgeUploadUrl(this: StudioService): string;
@@ -3641,6 +3643,7 @@ interface StudioService extends Instance {
 	 * displayClassIcon(imageLabel, "Part")
 	 */
 	GetClassIcon(this: StudioService, className: string): object;
+	GetPlaceIsPersistedToCloud(this: StudioService): boolean;
 	GetResourceByCategory(this: StudioService, category: string): object;
 	GetStartupAssetId(this: StudioService): string;
 	GetStartupPluginId(this: StudioService): string;
@@ -3649,17 +3652,18 @@ interface StudioService extends Instance {
 	 * Returns the studio user's userId if they're logged in, otherwise returns 0.
 	 */
 	GetUserId(this: StudioService): number;
+	GetUserIsInTeamCreateToggleRamp(this: StudioService): boolean;
 	GizmoRaycast(this: StudioService, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult;
 	HasInternalPermission(this: StudioService): boolean;
 	IsPluginInstalled(this: StudioService, assetId: number): boolean;
 	IsPluginUpToDate(this: StudioService, assetId: number, currentAssetVersion: number): boolean;
 	OpenInBrowser_DONOTUSE(this: StudioService, url: string): void;
-	PromptForLocalSave(this: StudioService): void;
 	PublishAs(this: StudioService, universeId: number, placeId: number, groupId: number): void;
+	RefreshDocumentDisplayName(this: StudioService): void;
 	RequestClose(this: StudioService, closeMode: CastsToEnum<Enum.StudioCloseMode>): void;
 	SerializeInstances(this: StudioService, instances: Array<Instance>): string;
-	SetDocumentDisplayName(this: StudioService, newName: string): void;
 	SetPluginEnabled(this: StudioService, assetId: number, state: boolean): void;
+	SetTurnOnTeamCreateOnPublish(this: StudioService, turnOn: boolean): void;
 	SetUniverseDisplayName(this: StudioService, newName: string): void;
 	ShowPlaceVersionHistoryDialog(this: StudioService, placeId: number): void;
 	ShowPublishToRoblox(this: StudioService): void;
@@ -3692,7 +3696,6 @@ interface StudioService extends Instance {
 	 * Tags: Yields
 	 */
 	TryInstallPlugin(this: StudioService, assetId: number, assetVersionId: number): void;
-	readonly FirstPublishOfCloudPlace: RBXScriptSignal<(universeId: number, placeId: number) => void>;
 	readonly GameNameUpdated: RBXScriptSignal<(name: string) => void>;
 	readonly GamePublishFinished: RBXScriptSignal<(success: boolean, gameId: number) => void>;
 	readonly OnConvertToPackageResult: RBXScriptSignal<(isSuccessful: boolean, errorMessage: string) => void>;
@@ -4088,3 +4091,18 @@ interface VersionControlService extends Instance {
 	readonly ScriptCollabEnabled: boolean;
 }
 
+interface VoiceChatService extends Instance {
+	/**
+	 * **DO NOT USE!**
+	 *
+	 * This field exists to force TypeScript to recognize this as a nominal type
+	 * @hidden
+	 * @deprecated
+	 */
+	readonly _nominal_VoiceChatService: unique symbol;
+	/**
+	 * Tags: NotBrowsable
+	 */
+	GenerateDefaultChannel: boolean;
+}
+