@rbxts/types 1.0.683 → 1.0.685

package/include/generated/None.d.ts

@@ -213,6 +213,7 @@ interface CreatableInstances {
 	DialogChoice: DialogChoice;
 	DistortionSoundEffect: DistortionSoundEffect;
 	DoubleConstrainedValue: DoubleConstrainedValue;
+	DragDetector: DragDetector;
 	Dragger: Dragger;
 	EchoSoundEffect: EchoSoundEffect;
 	EqualizerSoundEffect: EqualizerSoundEffect;
@@ -518,6 +519,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
 	TextChatConfigurations: TextChatConfigurations;
 	TextChatMessage: TextChatMessage;
 	TextFilterResult: TextFilterResult;
+	TextFilterTranslatedResult: TextFilterTranslatedResult;
 	TextSource: TextSource;
 	TextureGuiExperimental: TextureGuiExperimental;
 	ThreadState: ThreadState;
@@ -626,6 +628,7 @@ interface Instance {
 	 * Tags: NotReplicated
 	 */
 	Parent: Instance | undefined;
+	AddTag(this: Instance, tag: string): void;
 	/**
 	 * This function destroys all of an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s children.
 	 * 
@@ -926,6 +929,8 @@ interface Instance {
 		this: T,
 		propertyName: InstancePropertyNames<T>,
 	): RBXScriptSignal<() => void>;
+	GetTags(this: Instance): unknown;
+	HasTag(this: Instance, tag: string): boolean;
 	/**
 	 * IsA returns true if the [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s class is **equivalent to** or a **subclass** of a given class. This function is similar to the **instanceof** operators in other languages, and is a form of [type introspection](https://en.wikipedia.org/wiki/Type_introspection). To ignore class inheritance, test the [ClassName](https://developer.roblox.com/en-us/api-reference/property/Instance/ClassName) property directly instead. For checking native Lua data types (number, string, etc) use the functions `type` and `typeof`.
 	 * 
@@ -965,6 +970,7 @@ interface Instance {
 	 * See also, [Instance:IsAncestorOf](https://developer.roblox.com/en-us/api-reference/function/Instance/IsAncestorOf).
 	 */
 	IsDescendantOf(this: Instance, ancestor: Instance): boolean;
+	RemoveTag(this: Instance, tag: string): void;
 	/**
 	 * This function sets the attribute with the given name to the given value. If the value given is nil, then the attribute will be removed (since nil is returned by default).
 	 * 
@@ -2497,6 +2503,7 @@ interface Attachment extends Instance {
 	 * @deprecated
 	 */
 	GetAxis(this: Attachment): Vector3;
+	GetConstraints(this: Attachment): Array<Instance>;
 	/**
 	 * Returns the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
 	 * Tags: Deprecated, [object Object]
@@ -6506,6 +6513,61 @@ interface ClickDetector extends Instance {
 	readonly RightMouseClick: RBXScriptSignal<(playerWhoClicked: Player) => void>;
 }
 
+interface DragDetector extends ClickDetector {
+	/**
+	 * **DO NOT USE!**
+	 *
+	 * This field exists to force TypeScript to recognize this as a nominal type
+	 * @hidden
+	 * @deprecated
+	 */
+	readonly _nominal_DragDetector: unique symbol;
+	ApplyAtCenterOfMass: boolean;
+	/**
+	 * Tags: NotReplicated
+	 */
+	Axis: Vector3;
+	DragFrame: CFrame;
+	DragStyle: Enum.DragDetectorDragStyle;
+	Enabled: boolean;
+	GamepadModeSwitchKeyCode: Enum.KeyCode;
+	KeyboardModeSwitchKeyCode: Enum.KeyCode;
+	MaxDragAngle: number;
+	MaxDragTranslation: Vector3;
+	MaxForce: number;
+	MaxTorque: number;
+	MinDragAngle: number;
+	MinDragTranslation: Vector3;
+	Orientation: Vector3;
+	ReferenceInstance: Instance | undefined;
+	ResponseStyle: Enum.DragDetectorResponseStyle;
+	Responsiveness: number;
+	RunLocally: boolean;
+	/**
+	 * Tags: NotReplicated
+	 */
+	SecondaryAxis: Vector3;
+	TrackballRadialPullFactor: number;
+	TrackballRollFactor: number;
+	VRSwitchKeyCode: Enum.KeyCode;
+	/**
+	 * Tags: NotReplicated
+	 */
+	WorldAxis: Vector3;
+	/**
+	 * Tags: NotReplicated
+	 */
+	WorldSecondaryAxis: Vector3;
+	AddConstraintFunction(this: DragDetector, name: string, priority: number, callback: Callback): void;
+	GetReferenceFrame(this: DragDetector): CFrame;
+	RemoveConstraintFunction(this: DragDetector, name: string): void;
+	RestartDrag(this: DragDetector): void;
+	SetDragStyleFunction(this: DragDetector, callback: Callback): void;
+	readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
+	readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
+	readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
+}
+
 /** The **Clouds** object renders realistic clouds that drift slowly across the sky. Both cloud cover and density can be adjusted, as well as cloud color to achieve atmospheres like stormy skies, moody sunsets, alien worlds, etc.
  * 
  * See the [Dynamic Clouds](https://developer.roblox.com/articles/dynamic-clouds) article for a summary of properties and expected results.
@@ -23215,6 +23277,7 @@ interface BasePart extends PVInstance {
 	 * *   [Network ownership](https://developer.roblox.com/articles/Network-Ownership)
 	 */
 	CanSetNetworkOwnership(this: BasePart): LuaTuple<[boolean, string | undefined]>;
+	GetClosestPointOnSurface(this: BasePart, position: Vector3): Vector3;
 	/**
 	 * Returns a table of parts connected to the the object by any kind of rigid joint.
 	 * 
@@ -24426,6 +24489,7 @@ interface Model extends PVInstance {
 	 * @deprecated
 	 */
 	GetModelSize(this: Model): Vector3;
+	GetPersistentPlayers(this: Model): Array<Instance>;
 	/**
 	 * This function has been superseded by [PVInstance:GetPivot](https://developer.roblox.com/en-us/api-reference/function/PVInstance/GetPivot) which acts as a replacement and does not change your code's behavior. Use [PVInstance:GetPivot](https://developer.roblox.com/en-us/api-reference/function/PVInstance/GetPivot) for new work and migrate your existing [Model:GetPrimaryPartCFrame](https://developer.roblox.com/en-us/api-reference/function/Model/GetPrimaryPartCFrame) calls when convenient.
 	 * 
@@ -24780,7 +24844,13 @@ interface WorldRoot extends Model {
 	 * If no parts are provided, false is returned.
 	 */
 	ArePartsTouchingOthers(this: WorldRoot, partList: Array<Instance>, overlapIgnored?: number): boolean;
-	Blockcast(this: WorldRoot, cframe: CFrame, size: Vector3, direction: Vector3, params?: RaycastParams): RaycastResult;
+	Blockcast(
+		this: WorldRoot,
+		cframe: CFrame,
+		size: Vector3,
+		direction: Vector3,
+		raycastParams?: RaycastParams,
+	): RaycastResult | undefined;
 	/**
 	 * **Warning!**  
 	 * You should only use this function if you are sure that part movement is a bottleneck in your code, simply setting the CFrame property of the individual parts / welded models you want to move will be fast enough in the vast majority of cases.
@@ -25087,7 +25157,13 @@ interface WorldRoot extends Model {
 		direction: Vector3,
 		raycastParams?: RaycastParams,
 	): RaycastResult | undefined;
-	Spherecast(this: WorldRoot, position: Vector3, radius: number, direction: Vector3, params?: RaycastParams): RaycastResult;
+	Spherecast(
+		this: WorldRoot,
+		position: Vector3,
+		radius: number,
+		direction: Vector3,
+		raycastParams?: RaycastParams,
+	): RaycastResult | undefined;
 }
 
 /** The Workspace is the service in which any objects that are to be rendered in the 3D world exist. Objects not descending from Workspace will not be rendered or physically interact with the world.
@@ -25898,6 +25974,7 @@ interface ParticleEmitter extends Instance {
 	 * @deprecated
 	 */
 	VelocitySpread: number;
+	WindAffectsDrag: boolean;
 	/**
 	 * The ZOffset property determines the forward-backward (Z) render position of particles, in studs. they render at a modified [ParticleEmitter.Size](https://developer.roblox.com/en-us/api-reference/property/ParticleEmitter/Size) such that this property will not affect the screen size of particles. When changed, this property will affects all particles, both current and future particles. Note that this property accepts fractional values; it is not like [GuiObject.ZIndex](https://developer.roblox.com/en-us/api-reference/property/GuiObject/ZIndex) (an integer)
 	 * 
@@ -26579,6 +26656,8 @@ interface Player extends Instance {
 	 * When mouse lock is enabled, the player's cursor is locked to the center of the screen. Moving the mouse will orbit the camera around the player's [character](https://developer.roblox.com/en-us/api-reference/property/Player/Character), and character will face the same direction as the [camera](https://developer.roblox.com/en-us/api-reference/class/Camera). It also offsets the camera view just over the right shoulder of the player's character.
 	 * 
 	 * Below, the camera is moved left and right first by holding right-click. Then, mouse lock is enabled which changes the mouse to a target reticule, and offsets the camera. The camera is again moved left and right (without holding right click).
+	 * Tags: Deprecated
+	 * @deprecated
 	 */
 	DevEnableMouseLock: boolean;
 	/**
@@ -28996,9 +29075,14 @@ interface SyncScriptBuilder extends ScriptBuilder {
 	 * @deprecated
 	 */
 	readonly _nominal_SyncScriptBuilder: unique symbol;
+	CompileTarget: Enum.CompileTarget;
 	CoverageInfo: boolean;
 	DebugInfo: boolean;
 	PackAsSource: boolean;
+	/**
+	 * Tags: Deprecated, [object Object]
+	 * @deprecated
+	 */
 	RawBytecode: boolean;
 }
 
@@ -31219,6 +31303,8 @@ interface StarterPlayer extends Instance {
 	 * Mouselock will lock the player's cursor to the center of the screen. Moving the mouse will rotate the [Camera](https://developer.roblox.com/en-us/api-reference/class/Camera) and [Player](https://developer.roblox.com/en-us/api-reference/class/Player) will move relative to the current rotation of the camera.
 	 * 
 	 * This property sets the value of [Player.DevEnableMouseLock](https://developer.roblox.com/en-us/api-reference/property/Player/DevEnableMouseLock).
+	 * Tags: Deprecated
+	 * @deprecated
 	 */
 	EnableMouseLockOption: boolean;
 	/**
@@ -32829,6 +32915,26 @@ interface TextFilterResult extends Instance {
 	GetNonChatStringForUserAsync(this: TextFilterResult, toUserId: number): string;
 }
 
+interface TextFilterTranslatedResult extends Instance {
+	/**
+	 * **DO NOT USE!**
+	 *
+	 * This field exists to force TypeScript to recognize this as a nominal type
+	 * @hidden
+	 * @deprecated
+	 */
+	readonly _nominal_TextFilterTranslatedResult: unique symbol;
+	/**
+	 * Tags: ReadOnly, NotReplicated
+	 */
+	readonly SourceLanguage: string;
+	/**
+	 * Tags: ReadOnly, NotReplicated
+	 */
+	readonly SourceText: TextFilterResult | undefined;
+	GetTranslations(this: TextFilterTranslatedResult): object;
+}
+
 /** The TextService is a service internally responsible for handling the display of text in the game.
  * 
  * This class has two member functions,
@@ -32860,6 +32966,10 @@ interface TextService extends Instance {
 	 * Developers are recommended to add a pixel of padding to the result to ensure no text is cut off.
 	 */
 	GetTextSize(this: TextService, string: string, fontSize: number, font: CastsToEnum<Enum.Font>, frameSize: Vector2): Vector2;
+	/**
+	 * Tags: Yields
+	 */
+	FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<any>, textContext?: CastsToEnum<Enum.TextFilterContext>): Instance | undefined;
 	/**
 	 * The FilterStringAsync function filters a string being received from a user, using the [TextService](https://developer.roblox.com/en-us/api-reference/class/TextService), and returns a [TextFilterResult](https://developer.roblox.com/en-us/api-reference/class/TextFilterResult) which can be used to distribute the correctly filtered text accordingly.
 	 * 
@@ -34325,6 +34435,8 @@ interface UserGameSettings extends Instance {
 	ComputerMovementMode: Enum.ComputerMovementMode;
 	/**
 	 * Toggles whether or not the client can use the Mouse Lock Switch mode.
+	 * Tags: Deprecated
+	 * @deprecated
 	 */
 	ControlMode: Enum.ControlMode;
 	/**

package/include/generated/enums.d.ts

@@ -3398,6 +3398,43 @@ declare namespace Enum {
 	}
 	export type CommandPermission = CommandPermission.Plugin | CommandPermission.LocalUser;
 
+	export namespace CompileTarget {
+		export interface Client extends globalThis.EnumItem {
+			Name: "Client";
+			Value: 0;
+			EnumType: typeof globalThis.Enum.CompileTarget;
+		}
+
+		export const Client: Client;
+
+		export interface CoreScript extends globalThis.EnumItem {
+			Name: "CoreScript";
+			Value: 1;
+			EnumType: typeof globalThis.Enum.CompileTarget;
+		}
+
+		export const CoreScript: CoreScript;
+
+		export interface Studio extends globalThis.EnumItem {
+			Name: "Studio";
+			Value: 2;
+			EnumType: typeof globalThis.Enum.CompileTarget;
+		}
+
+		export const Studio: Studio;
+
+		export interface CoreScriptRaw extends globalThis.EnumItem {
+			Name: "CoreScriptRaw";
+			Value: 3;
+			EnumType: typeof globalThis.Enum.CompileTarget;
+		}
+
+		export const CoreScriptRaw: CoreScriptRaw;
+
+		export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CompileTarget>;
+	}
+	export type CompileTarget = CompileTarget.Client | CompileTarget.CoreScript | CompileTarget.Studio | CompileTarget.CoreScriptRaw;
+
 	export namespace CompletionItemKind {
 		export interface Text extends globalThis.EnumItem {
 			Name: "Text";
@@ -5442,6 +5479,112 @@ declare namespace Enum {
 	}
 	export type DraftStatusCode = DraftStatusCode.OK | DraftStatusCode.DraftOutdated | DraftStatusCode.ScriptRemoved | DraftStatusCode.DraftCommitted;
 
+	export namespace DragDetectorDragStyle {
+		export interface TranslateLine extends globalThis.EnumItem {
+			Name: "TranslateLine";
+			Value: 0;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const TranslateLine: TranslateLine;
+
+		export interface TranslatePlane extends globalThis.EnumItem {
+			Name: "TranslatePlane";
+			Value: 1;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const TranslatePlane: TranslatePlane;
+
+		export interface TranslatePlaneOrLine extends globalThis.EnumItem {
+			Name: "TranslatePlaneOrLine";
+			Value: 2;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const TranslatePlaneOrLine: TranslatePlaneOrLine;
+
+		export interface TranslateLineOrPlane extends globalThis.EnumItem {
+			Name: "TranslateLineOrPlane";
+			Value: 3;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const TranslateLineOrPlane: TranslateLineOrPlane;
+
+		export interface TranslateViewPlane extends globalThis.EnumItem {
+			Name: "TranslateViewPlane";
+			Value: 4;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const TranslateViewPlane: TranslateViewPlane;
+
+		export interface RotateAxis extends globalThis.EnumItem {
+			Name: "RotateAxis";
+			Value: 5;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const RotateAxis: RotateAxis;
+
+		export interface RotateTrackball extends globalThis.EnumItem {
+			Name: "RotateTrackball";
+			Value: 6;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const RotateTrackball: RotateTrackball;
+
+		export interface Scriptable extends globalThis.EnumItem {
+			Name: "Scriptable";
+			Value: 7;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const Scriptable: Scriptable;
+
+		export interface BestForDevice extends globalThis.EnumItem {
+			Name: "BestForDevice";
+			Value: 8;
+			EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
+		}
+
+		export const BestForDevice: BestForDevice;
+
+		export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorDragStyle>;
+	}
+	export type DragDetectorDragStyle = DragDetectorDragStyle.TranslateLine | DragDetectorDragStyle.TranslatePlane | DragDetectorDragStyle.TranslatePlaneOrLine | DragDetectorDragStyle.TranslateLineOrPlane | DragDetectorDragStyle.TranslateViewPlane | DragDetectorDragStyle.RotateAxis | DragDetectorDragStyle.RotateTrackball | DragDetectorDragStyle.Scriptable | DragDetectorDragStyle.BestForDevice;
+
+	export namespace DragDetectorResponseStyle {
+		export interface Geometric extends globalThis.EnumItem {
+			Name: "Geometric";
+			Value: 0;
+			EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
+		}
+
+		export const Geometric: Geometric;
+
+		export interface Physical extends globalThis.EnumItem {
+			Name: "Physical";
+			Value: 1;
+			EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
+		}
+
+		export const Physical: Physical;
+
+		export interface Custom extends globalThis.EnumItem {
+			Name: "Custom";
+			Value: 2;
+			EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
+		}
+
+		export const Custom: Custom;
+
+		export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorResponseStyle>;
+	}
+	export type DragDetectorResponseStyle = DragDetectorResponseStyle.Geometric | DragDetectorResponseStyle.Physical | DragDetectorResponseStyle.Custom;
+
 	export namespace DraggerCoordinateSpace {
 		export interface Object extends globalThis.EnumItem {
 			Name: "Object";

package/package.json

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