@rbxts/types 1.0.684 → 1.0.685

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -213,6 +213,7 @@ interface CreatableInstances {
213
213
  DialogChoice: DialogChoice;
214
214
  DistortionSoundEffect: DistortionSoundEffect;
215
215
  DoubleConstrainedValue: DoubleConstrainedValue;
216
+ DragDetector: DragDetector;
216
217
  Dragger: Dragger;
217
218
  EchoSoundEffect: EchoSoundEffect;
218
219
  EqualizerSoundEffect: EqualizerSoundEffect;
@@ -518,6 +519,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
518
519
  TextChatConfigurations: TextChatConfigurations;
519
520
  TextChatMessage: TextChatMessage;
520
521
  TextFilterResult: TextFilterResult;
522
+ TextFilterTranslatedResult: TextFilterTranslatedResult;
521
523
  TextSource: TextSource;
522
524
  TextureGuiExperimental: TextureGuiExperimental;
523
525
  ThreadState: ThreadState;
@@ -626,6 +628,7 @@ interface Instance {
626
628
  * Tags: NotReplicated
627
629
  */
628
630
  Parent: Instance | undefined;
631
+ AddTag(this: Instance, tag: string): void;
629
632
  /**
630
633
  * This function destroys all of an [Instance](https://developer.roblox.com/en-us/api-reference/class/Instance)'s children.
631
634
  *
@@ -926,6 +929,8 @@ interface Instance {
926
929
  this: T,
927
930
  propertyName: InstancePropertyNames<T>,
928
931
  ): RBXScriptSignal<() => void>;
932
+ GetTags(this: Instance): unknown;
933
+ HasTag(this: Instance, tag: string): boolean;
929
934
  /**
930
935
  * 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`.
931
936
  *
@@ -965,6 +970,7 @@ interface Instance {
965
970
  * See also, [Instance:IsAncestorOf](https://developer.roblox.com/en-us/api-reference/function/Instance/IsAncestorOf).
966
971
  */
967
972
  IsDescendantOf(this: Instance, ancestor: Instance): boolean;
973
+ RemoveTag(this: Instance, tag: string): void;
968
974
  /**
969
975
  * 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).
970
976
  *
@@ -2497,6 +2503,7 @@ interface Attachment extends Instance {
2497
2503
  * @deprecated
2498
2504
  */
2499
2505
  GetAxis(this: Attachment): Vector3;
2506
+ GetConstraints(this: Attachment): Array<Instance>;
2500
2507
  /**
2501
2508
  * Returns the value of the Attachment's [Attachment.SecondaryAxis](https://developer.roblox.com/en-us/api-reference/property/Attachment/SecondaryAxis).
2502
2509
  * Tags: Deprecated, [object Object]
@@ -6506,6 +6513,61 @@ interface ClickDetector extends Instance {
6506
6513
  readonly RightMouseClick: RBXScriptSignal<(playerWhoClicked: Player) => void>;
6507
6514
  }
6508
6515
 
6516
+ interface DragDetector extends ClickDetector {
6517
+ /**
6518
+ * **DO NOT USE!**
6519
+ *
6520
+ * This field exists to force TypeScript to recognize this as a nominal type
6521
+ * @hidden
6522
+ * @deprecated
6523
+ */
6524
+ readonly _nominal_DragDetector: unique symbol;
6525
+ ApplyAtCenterOfMass: boolean;
6526
+ /**
6527
+ * Tags: NotReplicated
6528
+ */
6529
+ Axis: Vector3;
6530
+ DragFrame: CFrame;
6531
+ DragStyle: Enum.DragDetectorDragStyle;
6532
+ Enabled: boolean;
6533
+ GamepadModeSwitchKeyCode: Enum.KeyCode;
6534
+ KeyboardModeSwitchKeyCode: Enum.KeyCode;
6535
+ MaxDragAngle: number;
6536
+ MaxDragTranslation: Vector3;
6537
+ MaxForce: number;
6538
+ MaxTorque: number;
6539
+ MinDragAngle: number;
6540
+ MinDragTranslation: Vector3;
6541
+ Orientation: Vector3;
6542
+ ReferenceInstance: Instance | undefined;
6543
+ ResponseStyle: Enum.DragDetectorResponseStyle;
6544
+ Responsiveness: number;
6545
+ RunLocally: boolean;
6546
+ /**
6547
+ * Tags: NotReplicated
6548
+ */
6549
+ SecondaryAxis: Vector3;
6550
+ TrackballRadialPullFactor: number;
6551
+ TrackballRollFactor: number;
6552
+ VRSwitchKeyCode: Enum.KeyCode;
6553
+ /**
6554
+ * Tags: NotReplicated
6555
+ */
6556
+ WorldAxis: Vector3;
6557
+ /**
6558
+ * Tags: NotReplicated
6559
+ */
6560
+ WorldSecondaryAxis: Vector3;
6561
+ AddConstraintFunction(this: DragDetector, name: string, priority: number, callback: Callback): void;
6562
+ GetReferenceFrame(this: DragDetector): CFrame;
6563
+ RemoveConstraintFunction(this: DragDetector, name: string): void;
6564
+ RestartDrag(this: DragDetector): void;
6565
+ SetDragStyleFunction(this: DragDetector, callback: Callback): void;
6566
+ readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
6567
+ readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
6568
+ readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
6569
+ }
6570
+
6509
6571
  /** 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.
6510
6572
  *
6511
6573
  * 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 {
23215
23277
  * * [Network ownership](https://developer.roblox.com/articles/Network-Ownership)
23216
23278
  */
23217
23279
  CanSetNetworkOwnership(this: BasePart): LuaTuple<[boolean, string | undefined]>;
23280
+ GetClosestPointOnSurface(this: BasePart, position: Vector3): Vector3;
23218
23281
  /**
23219
23282
  * Returns a table of parts connected to the the object by any kind of rigid joint.
23220
23283
  *
@@ -24426,6 +24489,7 @@ interface Model extends PVInstance {
24426
24489
  * @deprecated
24427
24490
  */
24428
24491
  GetModelSize(this: Model): Vector3;
24492
+ GetPersistentPlayers(this: Model): Array<Instance>;
24429
24493
  /**
24430
24494
  * 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.
24431
24495
  *
@@ -25910,6 +25974,7 @@ interface ParticleEmitter extends Instance {
25910
25974
  * @deprecated
25911
25975
  */
25912
25976
  VelocitySpread: number;
25977
+ WindAffectsDrag: boolean;
25913
25978
  /**
25914
25979
  * 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)
25915
25980
  *
@@ -26591,6 +26656,8 @@ interface Player extends Instance {
26591
26656
  * 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.
26592
26657
  *
26593
26658
  * 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).
26659
+ * Tags: Deprecated
26660
+ * @deprecated
26594
26661
  */
26595
26662
  DevEnableMouseLock: boolean;
26596
26663
  /**
@@ -29008,9 +29075,14 @@ interface SyncScriptBuilder extends ScriptBuilder {
29008
29075
  * @deprecated
29009
29076
  */
29010
29077
  readonly _nominal_SyncScriptBuilder: unique symbol;
29078
+ CompileTarget: Enum.CompileTarget;
29011
29079
  CoverageInfo: boolean;
29012
29080
  DebugInfo: boolean;
29013
29081
  PackAsSource: boolean;
29082
+ /**
29083
+ * Tags: Deprecated, [object Object]
29084
+ * @deprecated
29085
+ */
29014
29086
  RawBytecode: boolean;
29015
29087
  }
29016
29088
 
@@ -31231,6 +31303,8 @@ interface StarterPlayer extends Instance {
31231
31303
  * 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.
31232
31304
  *
31233
31305
  * This property sets the value of [Player.DevEnableMouseLock](https://developer.roblox.com/en-us/api-reference/property/Player/DevEnableMouseLock).
31306
+ * Tags: Deprecated
31307
+ * @deprecated
31234
31308
  */
31235
31309
  EnableMouseLockOption: boolean;
31236
31310
  /**
@@ -32841,6 +32915,26 @@ interface TextFilterResult extends Instance {
32841
32915
  GetNonChatStringForUserAsync(this: TextFilterResult, toUserId: number): string;
32842
32916
  }
32843
32917
 
32918
+ interface TextFilterTranslatedResult extends Instance {
32919
+ /**
32920
+ * **DO NOT USE!**
32921
+ *
32922
+ * This field exists to force TypeScript to recognize this as a nominal type
32923
+ * @hidden
32924
+ * @deprecated
32925
+ */
32926
+ readonly _nominal_TextFilterTranslatedResult: unique symbol;
32927
+ /**
32928
+ * Tags: ReadOnly, NotReplicated
32929
+ */
32930
+ readonly SourceLanguage: string;
32931
+ /**
32932
+ * Tags: ReadOnly, NotReplicated
32933
+ */
32934
+ readonly SourceText: TextFilterResult | undefined;
32935
+ GetTranslations(this: TextFilterTranslatedResult): object;
32936
+ }
32937
+
32844
32938
  /** The TextService is a service internally responsible for handling the display of text in the game.
32845
32939
  *
32846
32940
  * This class has two member functions,
@@ -32872,6 +32966,10 @@ interface TextService extends Instance {
32872
32966
  * Developers are recommended to add a pixel of padding to the result to ensure no text is cut off.
32873
32967
  */
32874
32968
  GetTextSize(this: TextService, string: string, fontSize: number, font: CastsToEnum<Enum.Font>, frameSize: Vector2): Vector2;
32969
+ /**
32970
+ * Tags: Yields
32971
+ */
32972
+ FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<any>, textContext?: CastsToEnum<Enum.TextFilterContext>): Instance | undefined;
32875
32973
  /**
32876
32974
  * 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.
32877
32975
  *
@@ -34337,6 +34435,8 @@ interface UserGameSettings extends Instance {
34337
34435
  ComputerMovementMode: Enum.ComputerMovementMode;
34338
34436
  /**
34339
34437
  * Toggles whether or not the client can use the Mouse Lock Switch mode.
34438
+ * Tags: Deprecated
34439
+ * @deprecated
34340
34440
  */
34341
34441
  ControlMode: Enum.ControlMode;
34342
34442
  /**
@@ -3398,6 +3398,43 @@ declare namespace Enum {
3398
3398
  }
3399
3399
  export type CommandPermission = CommandPermission.Plugin | CommandPermission.LocalUser;
3400
3400
 
3401
+ export namespace CompileTarget {
3402
+ export interface Client extends globalThis.EnumItem {
3403
+ Name: "Client";
3404
+ Value: 0;
3405
+ EnumType: typeof globalThis.Enum.CompileTarget;
3406
+ }
3407
+
3408
+ export const Client: Client;
3409
+
3410
+ export interface CoreScript extends globalThis.EnumItem {
3411
+ Name: "CoreScript";
3412
+ Value: 1;
3413
+ EnumType: typeof globalThis.Enum.CompileTarget;
3414
+ }
3415
+
3416
+ export const CoreScript: CoreScript;
3417
+
3418
+ export interface Studio extends globalThis.EnumItem {
3419
+ Name: "Studio";
3420
+ Value: 2;
3421
+ EnumType: typeof globalThis.Enum.CompileTarget;
3422
+ }
3423
+
3424
+ export const Studio: Studio;
3425
+
3426
+ export interface CoreScriptRaw extends globalThis.EnumItem {
3427
+ Name: "CoreScriptRaw";
3428
+ Value: 3;
3429
+ EnumType: typeof globalThis.Enum.CompileTarget;
3430
+ }
3431
+
3432
+ export const CoreScriptRaw: CoreScriptRaw;
3433
+
3434
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CompileTarget>;
3435
+ }
3436
+ export type CompileTarget = CompileTarget.Client | CompileTarget.CoreScript | CompileTarget.Studio | CompileTarget.CoreScriptRaw;
3437
+
3401
3438
  export namespace CompletionItemKind {
3402
3439
  export interface Text extends globalThis.EnumItem {
3403
3440
  Name: "Text";
@@ -5442,6 +5479,112 @@ declare namespace Enum {
5442
5479
  }
5443
5480
  export type DraftStatusCode = DraftStatusCode.OK | DraftStatusCode.DraftOutdated | DraftStatusCode.ScriptRemoved | DraftStatusCode.DraftCommitted;
5444
5481
 
5482
+ export namespace DragDetectorDragStyle {
5483
+ export interface TranslateLine extends globalThis.EnumItem {
5484
+ Name: "TranslateLine";
5485
+ Value: 0;
5486
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5487
+ }
5488
+
5489
+ export const TranslateLine: TranslateLine;
5490
+
5491
+ export interface TranslatePlane extends globalThis.EnumItem {
5492
+ Name: "TranslatePlane";
5493
+ Value: 1;
5494
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5495
+ }
5496
+
5497
+ export const TranslatePlane: TranslatePlane;
5498
+
5499
+ export interface TranslatePlaneOrLine extends globalThis.EnumItem {
5500
+ Name: "TranslatePlaneOrLine";
5501
+ Value: 2;
5502
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5503
+ }
5504
+
5505
+ export const TranslatePlaneOrLine: TranslatePlaneOrLine;
5506
+
5507
+ export interface TranslateLineOrPlane extends globalThis.EnumItem {
5508
+ Name: "TranslateLineOrPlane";
5509
+ Value: 3;
5510
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5511
+ }
5512
+
5513
+ export const TranslateLineOrPlane: TranslateLineOrPlane;
5514
+
5515
+ export interface TranslateViewPlane extends globalThis.EnumItem {
5516
+ Name: "TranslateViewPlane";
5517
+ Value: 4;
5518
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5519
+ }
5520
+
5521
+ export const TranslateViewPlane: TranslateViewPlane;
5522
+
5523
+ export interface RotateAxis extends globalThis.EnumItem {
5524
+ Name: "RotateAxis";
5525
+ Value: 5;
5526
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5527
+ }
5528
+
5529
+ export const RotateAxis: RotateAxis;
5530
+
5531
+ export interface RotateTrackball extends globalThis.EnumItem {
5532
+ Name: "RotateTrackball";
5533
+ Value: 6;
5534
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5535
+ }
5536
+
5537
+ export const RotateTrackball: RotateTrackball;
5538
+
5539
+ export interface Scriptable extends globalThis.EnumItem {
5540
+ Name: "Scriptable";
5541
+ Value: 7;
5542
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5543
+ }
5544
+
5545
+ export const Scriptable: Scriptable;
5546
+
5547
+ export interface BestForDevice extends globalThis.EnumItem {
5548
+ Name: "BestForDevice";
5549
+ Value: 8;
5550
+ EnumType: typeof globalThis.Enum.DragDetectorDragStyle;
5551
+ }
5552
+
5553
+ export const BestForDevice: BestForDevice;
5554
+
5555
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorDragStyle>;
5556
+ }
5557
+ export type DragDetectorDragStyle = DragDetectorDragStyle.TranslateLine | DragDetectorDragStyle.TranslatePlane | DragDetectorDragStyle.TranslatePlaneOrLine | DragDetectorDragStyle.TranslateLineOrPlane | DragDetectorDragStyle.TranslateViewPlane | DragDetectorDragStyle.RotateAxis | DragDetectorDragStyle.RotateTrackball | DragDetectorDragStyle.Scriptable | DragDetectorDragStyle.BestForDevice;
5558
+
5559
+ export namespace DragDetectorResponseStyle {
5560
+ export interface Geometric extends globalThis.EnumItem {
5561
+ Name: "Geometric";
5562
+ Value: 0;
5563
+ EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
5564
+ }
5565
+
5566
+ export const Geometric: Geometric;
5567
+
5568
+ export interface Physical extends globalThis.EnumItem {
5569
+ Name: "Physical";
5570
+ Value: 1;
5571
+ EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
5572
+ }
5573
+
5574
+ export const Physical: Physical;
5575
+
5576
+ export interface Custom extends globalThis.EnumItem {
5577
+ Name: "Custom";
5578
+ Value: 2;
5579
+ EnumType: typeof globalThis.Enum.DragDetectorResponseStyle;
5580
+ }
5581
+
5582
+ export const Custom: Custom;
5583
+
5584
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DragDetectorResponseStyle>;
5585
+ }
5586
+ export type DragDetectorResponseStyle = DragDetectorResponseStyle.Geometric | DragDetectorResponseStyle.Physical | DragDetectorResponseStyle.Custom;
5587
+
5445
5588
  export namespace DraggerCoordinateSpace {
5446
5589
  export interface Object extends globalThis.EnumItem {
5447
5590
  Name: "Object";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.684",
3
+ "version": "1.0.685",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },