@rbxts/types 1.0.689 → 1.0.691

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.
@@ -46,6 +46,7 @@ interface Services {
46
46
  FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
47
47
  GamepadService: GamepadService;
48
48
  GamePassService: GamePassService;
49
+ GeometryService: GeometryService;
49
50
  GroupService: GroupService;
50
51
  GuiService: GuiService;
51
52
  HapticService: HapticService;
@@ -75,6 +76,7 @@ interface Services {
75
76
  MessagingService: MessagingService;
76
77
  MetaBreakpointManager: MetaBreakpointManager;
77
78
  OmniRecommendationsService: OmniRecommendationsService;
79
+ OpenCloudService: OpenCloudService;
78
80
  PackageUIService: PackageUIService;
79
81
  PatchBundlerFileWatch: PatchBundlerFileWatch;
80
82
  PathfindingService: PathfindingService;
@@ -90,6 +92,7 @@ interface Services {
90
92
  RemoteDebuggerServer: RemoteDebuggerServer;
91
93
  ReplicatedFirst: ReplicatedFirst;
92
94
  ReplicatedStorage: ReplicatedStorage;
95
+ RomarkService: RomarkService;
93
96
  RtMessagingService: RtMessagingService;
94
97
  RunService: RunService;
95
98
  SafetyService: SafetyService;
@@ -8558,8 +8561,8 @@ interface ControllerBase extends Instance {
8558
8561
  * @deprecated
8559
8562
  */
8560
8563
  readonly _nominal_ControllerBase: unique symbol;
8564
+ BalanceRigidityEnabled: boolean;
8561
8565
  MoveSpeedFactor: number;
8562
- RigidityEnabled: boolean;
8563
8566
  }
8564
8567
 
8565
8568
  interface AirController extends ControllerBase {
@@ -8572,21 +8575,13 @@ interface AirController extends ControllerBase {
8572
8575
  */
8573
8576
  readonly _nominal_AirController: unique symbol;
8574
8577
  BalanceMaxTorque: number;
8575
- BalanceRigidityEnabled: boolean;
8576
8578
  BalanceSpeed: number;
8577
8579
  LinearImpulse: Vector3;
8578
8580
  MaintainAngularMomentum: boolean;
8579
8581
  MaintainLinearMomentum: boolean;
8580
8582
  MoveMaxForce: number;
8581
- OrientationMaxTorque: number;
8582
- OrientationSpeedFactor: number;
8583
8583
  TurnMaxTorque: number;
8584
8584
  TurnSpeedFactor: number;
8585
- /**
8586
- * Tags: Hidden, NotReplicated, Deprecated
8587
- * @deprecated
8588
- */
8589
- VectorForce: Vector3;
8590
8585
  }
8591
8586
 
8592
8587
  interface ClimbController extends ControllerBase {
@@ -8600,11 +8595,8 @@ interface ClimbController extends ControllerBase {
8600
8595
  readonly _nominal_ClimbController: unique symbol;
8601
8596
  AccelerationTime: number;
8602
8597
  BalanceMaxTorque: number;
8603
- BalanceRigidityEnabled: boolean;
8604
8598
  BalanceSpeed: number;
8605
8599
  MoveMaxForce: number;
8606
- OrientationMaxTorque: number;
8607
- OrientationSpeedFactor: number;
8608
8600
  }
8609
8601
 
8610
8602
  interface GroundController extends ControllerBase {
@@ -8618,10 +8610,7 @@ interface GroundController extends ControllerBase {
8618
8610
  readonly _nominal_GroundController: unique symbol;
8619
8611
  AccelerationLean: number;
8620
8612
  AccelerationTime: number;
8621
- AlignSpeed: number;
8622
- AlignTorque: number;
8623
8613
  BalanceMaxTorque: number;
8624
- BalanceRigidityEnabled: boolean;
8625
8614
  BalanceSpeed: number;
8626
8615
  DecelerationTime: number;
8627
8616
  Friction: number;
@@ -8630,7 +8619,6 @@ interface GroundController extends ControllerBase {
8630
8619
  StandForce: number;
8631
8620
  StandSpeed: number;
8632
8621
  TurnSpeedFactor: number;
8633
- TurningFactor: number;
8634
8622
  }
8635
8623
 
8636
8624
  interface SwimController extends ControllerBase {
@@ -10569,6 +10557,30 @@ interface GamepadService extends Instance {
10569
10557
  EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
10570
10558
  }
10571
10559
 
10560
+ interface GeometryService extends Instance {
10561
+ /**
10562
+ * **DO NOT USE!**
10563
+ *
10564
+ * This field exists to force TypeScript to recognize this as a nominal type
10565
+ * @hidden
10566
+ * @deprecated
10567
+ */
10568
+ readonly _nominal_GeometryService: unique symbol;
10569
+ CalculateConstraintsToPreserve(this: GeometryService, source: Instance, destination: Array<Instance>, options: unknown): object;
10570
+ /**
10571
+ * Tags: Yields
10572
+ */
10573
+ IntersectAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options: unknown): Array<Instance>;
10574
+ /**
10575
+ * Tags: Yields
10576
+ */
10577
+ SubtractAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options: unknown): Array<Instance>;
10578
+ /**
10579
+ * Tags: Yields
10580
+ */
10581
+ UnionAsync(this: GeometryService, part: BasePart, parts: Array<Instance>, options: unknown): Array<Instance>;
10582
+ }
10583
+
10572
10584
  interface GetTextBoundsParams extends Instance {
10573
10585
  /**
10574
10586
  * **DO NOT USE!**
@@ -12106,6 +12118,7 @@ interface TextButton extends GuiButton {
12106
12118
  * It's important that text is easily read by players! Be sure to choose colors with little-to-no saturation, like white, grey, or black. Make sure the color of your text is contrasted by the `TextButton/BackgroundColor3` of the UI element. If the element has a transparent background, try applying a black [TextButton.TextStrokeColor3](https://developer.roblox.com/en-us/api-reference/property/TextButton/TextStrokeColor3) to help contrast the text with the 3D world behind it.
12107
12119
  */
12108
12120
  TextColor3: Color3;
12121
+ TextDirection: Enum.TextDirection;
12109
12122
  /**
12110
12123
  * A boolean representation of whether the TextButton's text fits within the size of it.
12111
12124
  * Tags: ReadOnly, NotReplicated
@@ -12419,6 +12432,7 @@ interface TextLabel extends GuiLabel {
12419
12432
  * It's important that text is easily read by players! Be sure to choose colors with little-to-no saturation, like white, grey, or black. Make sure the color of your text is contrasted by the `TextLabel/BackgroundColor3` of the GUI element. If the element has a transparent background, try applying a black [TextLabel.TextStrokeColor3](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextStrokeColor3) to help contrast the text with the 3D world behind it.
12420
12433
  */
12421
12434
  TextColor3: Color3;
12435
+ TextDirection: Enum.TextDirection;
12422
12436
  /**
12423
12437
  * The TextFits is a read-only property that is false if [TextLabel.Text](https://developer.roblox.com/en-us/api-reference/property/TextLabel/Text) content does not fit within the [GuiBase2d.AbsoluteSize](https://developer.roblox.com/en-us/api-reference/property/GuiBase2d/AbsoluteSize) when rendered. If [TextLabel.TextWrapped](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextWrapped) is true, a false value indicates that some text is truncated and not rendering. Otherwise, it indicates if the line of text is rendering outside the UI element's rectangle. If [TextLabel.TextScaled](https://developer.roblox.com/en-us/api-reference/property/TextLabel/TextScaled) is enabled, this property will be disabled when text must be scaled down in order to fit.
12424
12438
  * Tags: ReadOnly, NotReplicated
@@ -12823,6 +12837,7 @@ interface TextBox extends GuiObject {
12823
12837
  * It's important that text is easily read by players! Be sure to choose colors with little-to-no saturation, like white, grey, or black. Make sure the color of your text is contrasted by the `TextBox/BackgroundColor3` of the UI element. If the element has a transparent background, try applying a black [TextBox.TextStrokeColor3](https://developer.roblox.com/en-us/api-reference/property/TextBox/TextStrokeColor3) to help contrast the text with the 3D world behind it.
12824
12838
  */
12825
12839
  TextColor3: Color3;
12840
+ TextDirection: Enum.TextDirection;
12826
12841
  /**
12827
12842
  * **TextEditable** determines whether the user can change the [Text](https://developer.roblox.com/en-us/api-reference/property/TextBox/Text) through input. It is recommended to disable [ClearTextOnFocus](https://developer.roblox.com/en-us/api-reference/property/TextBox/ClearTextOnFocus) when this property is disabled, otherwise the Text could be cleared on-focus. This property is useful to make read-only TextBoxes from which content can be copied in-game.
12828
12843
  */
@@ -22529,6 +22544,17 @@ interface OmniRecommendationsService extends Instance {
22529
22544
  readonly _nominal_OmniRecommendationsService: unique symbol;
22530
22545
  }
22531
22546
 
22547
+ interface OpenCloudService extends Instance {
22548
+ /**
22549
+ * **DO NOT USE!**
22550
+ *
22551
+ * This field exists to force TypeScript to recognize this as a nominal type
22552
+ * @hidden
22553
+ * @deprecated
22554
+ */
22555
+ readonly _nominal_OpenCloudService: unique symbol;
22556
+ }
22557
+
22532
22558
  /** A [PVInstance](https://developer.roblox.com/en-us/api-reference/class/PVInstance) (“Position Velocity Instance”) is an abstract class that cannot be created. It is the base for all objects that have a physical location in the world, specifically [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) and [Models](https://developer.roblox.com/en-us/api-reference/class/Model). */
22533
22559
  interface PVInstance extends Instance {
22534
22560
  /**
@@ -22818,6 +22844,7 @@ interface BasePart extends PVInstance {
22818
22844
  * @deprecated
22819
22845
  */
22820
22846
  Elasticity: number;
22847
+ EnableFluidForces: boolean;
22821
22848
  /**
22822
22849
  * Tags: ReadOnly, NotReplicated
22823
22850
  */
@@ -25258,6 +25285,7 @@ interface Workspace extends WorldRoot {
25258
25285
  readonly BreakJoints: never;
25259
25286
  /** Do not use `Workspace.MakeJoints`. Use a for-loop instead */
25260
25287
  readonly MakeJoints: never;
25288
+ AirDensity: number;
25261
25289
  /**
25262
25290
  * This [Workspace](https://developer.roblox.com/en-us/api-reference/class/Workspace) property determines whether assets created by other uses can be sold in the game.
25263
25291
  *
@@ -25317,6 +25345,7 @@ interface Workspace extends WorldRoot {
25317
25345
  * Tags: NotReplicated
25318
25346
  */
25319
25347
  DistributedGameTime: number;
25348
+ EnableFluidForces: boolean;
25320
25349
  /**
25321
25350
  * This property determines the height at which falling [BaseParts](https://developer.roblox.com/en-us/api-reference/class/BasePart) (and their ancestor [Models](https://developer.roblox.com/en-us/api-reference/class/Model)) are destroyed.
25322
25351
  *
@@ -28655,6 +28684,17 @@ interface ReplicatedStorage extends Instance {
28655
28684
  readonly _nominal_ReplicatedStorage: unique symbol;
28656
28685
  }
28657
28686
 
28687
+ interface RomarkService extends Instance {
28688
+ /**
28689
+ * **DO NOT USE!**
28690
+ *
28691
+ * This field exists to force TypeScript to recognize this as a nominal type
28692
+ * @hidden
28693
+ * @deprecated
28694
+ */
28695
+ readonly _nominal_RomarkService: unique symbol;
28696
+ }
28697
+
28658
28698
  /** A sorted list of [RotationCurveKey](https://developer.roblox.com/en-us/api-reference/class/RotationCurveKeys). RotationCurveKeys are value-time points on a curve that dictate the animation curves. It provides a sampling method returning its result as the rotation component of a CFrame. */
28659
28699
  interface RotationCurve extends Instance {
28660
28700
  /**
@@ -34622,10 +34662,6 @@ interface UserGameSettings extends Instance {
34622
34662
  * The type of controls being used by the client on a mobile device.
34623
34663
  */
34624
34664
  TouchMovementMode: Enum.TouchMovementMode;
34625
- /**
34626
- * Tags: Hidden, NotReplicated
34627
- */
34628
- readonly VRPlayMode: Enum.VRPlayMode;
34629
34665
  readonly VRSmoothRotationEnabled: boolean;
34630
34666
  readonly VignetteEnabled: boolean;
34631
34667
  /**
@@ -7984,6 +7984,35 @@ declare namespace Enum {
7984
7984
  }
7985
7985
  export type IKCollisionsMode = IKCollisionsMode.NoCollisions | IKCollisionsMode.OtherMechanismsAnchored | IKCollisionsMode.IncludeContactedMechanisms;
7986
7986
 
7987
+ export namespace IKControlConstraintSupport {
7988
+ export interface Default extends globalThis.EnumItem {
7989
+ Name: "Default";
7990
+ Value: 0;
7991
+ EnumType: typeof globalThis.Enum.IKControlConstraintSupport;
7992
+ }
7993
+
7994
+ export const Default: Default;
7995
+
7996
+ export interface Disabled extends globalThis.EnumItem {
7997
+ Name: "Disabled";
7998
+ Value: 1;
7999
+ EnumType: typeof globalThis.Enum.IKControlConstraintSupport;
8000
+ }
8001
+
8002
+ export const Disabled: Disabled;
8003
+
8004
+ export interface Enabled extends globalThis.EnumItem {
8005
+ Name: "Enabled";
8006
+ Value: 2;
8007
+ EnumType: typeof globalThis.Enum.IKControlConstraintSupport;
8008
+ }
8009
+
8010
+ export const Enabled: Enabled;
8011
+
8012
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.IKControlConstraintSupport>;
8013
+ }
8014
+ export type IKControlConstraintSupport = IKControlConstraintSupport.Default | IKControlConstraintSupport.Disabled | IKControlConstraintSupport.Enabled;
8015
+
7987
8016
  export namespace IKControlType {
7988
8017
  export interface Transform extends globalThis.EnumItem {
7989
8018
  Name: "Transform";
@@ -17226,6 +17255,35 @@ declare namespace Enum {
17226
17255
  }
17227
17256
  export type TextChatMessageStatus = TextChatMessageStatus.Unknown | TextChatMessageStatus.Success | TextChatMessageStatus.Sending | TextChatMessageStatus.TextFilterFailed | TextChatMessageStatus.Floodchecked | TextChatMessageStatus.InvalidPrivacySettings | TextChatMessageStatus.InvalidTextChannelPermissions | TextChatMessageStatus.MessageTooLong;
17228
17257
 
17258
+ export namespace TextDirection {
17259
+ export interface Auto extends globalThis.EnumItem {
17260
+ Name: "Auto";
17261
+ Value: 0;
17262
+ EnumType: typeof globalThis.Enum.TextDirection;
17263
+ }
17264
+
17265
+ export const Auto: Auto;
17266
+
17267
+ export interface LeftToRight extends globalThis.EnumItem {
17268
+ Name: "LeftToRight";
17269
+ Value: 1;
17270
+ EnumType: typeof globalThis.Enum.TextDirection;
17271
+ }
17272
+
17273
+ export const LeftToRight: LeftToRight;
17274
+
17275
+ export interface RightToLeft extends globalThis.EnumItem {
17276
+ Name: "RightToLeft";
17277
+ Value: 2;
17278
+ EnumType: typeof globalThis.Enum.TextDirection;
17279
+ }
17280
+
17281
+ export const RightToLeft: RightToLeft;
17282
+
17283
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.TextDirection>;
17284
+ }
17285
+ export type TextDirection = TextDirection.Auto | TextDirection.LeftToRight | TextDirection.RightToLeft;
17286
+
17229
17287
  export namespace TextFilterContext {
17230
17288
  export interface PublicChat extends globalThis.EnumItem {
17231
17289
  Name: "PublicChat";
@@ -18437,27 +18495,6 @@ declare namespace Enum {
18437
18495
  }
18438
18496
  export type UserInputType = UserInputType.MouseButton1 | UserInputType.MouseButton2 | UserInputType.MouseButton3 | UserInputType.MouseWheel | UserInputType.MouseMovement | UserInputType.Touch | UserInputType.Keyboard | UserInputType.Focus | UserInputType.Accelerometer | UserInputType.Gyro | UserInputType.Gamepad1 | UserInputType.Gamepad2 | UserInputType.Gamepad3 | UserInputType.Gamepad4 | UserInputType.Gamepad5 | UserInputType.Gamepad6 | UserInputType.Gamepad7 | UserInputType.Gamepad8 | UserInputType.TextInput | UserInputType.InputMethod | UserInputType.None;
18439
18497
 
18440
- export namespace VRPlayMode {
18441
- export interface Seated extends globalThis.EnumItem {
18442
- Name: "Seated";
18443
- Value: 0;
18444
- EnumType: typeof globalThis.Enum.VRPlayMode;
18445
- }
18446
-
18447
- export const Seated: Seated;
18448
-
18449
- export interface Standing extends globalThis.EnumItem {
18450
- Name: "Standing";
18451
- Value: 1;
18452
- EnumType: typeof globalThis.Enum.VRPlayMode;
18453
- }
18454
-
18455
- export const Standing: Standing;
18456
-
18457
- export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VRPlayMode>;
18458
- }
18459
- export type VRPlayMode = VRPlayMode.Seated | VRPlayMode.Standing;
18460
-
18461
18498
  export namespace VRSafetyBubbleMode {
18462
18499
  export interface NoOne extends globalThis.EnumItem {
18463
18500
  Name: "NoOne";
@@ -1875,6 +1875,8 @@ type RotationCurveKeyConstructor = new (
1875
1875
  ) => RotationCurveKey;
1876
1876
  declare const RotationCurveKey: RotationCurveKeyConstructor;
1877
1877
 
1878
+ declare const SharedTableNominal: unique symbol;
1879
+ type SharedTableValue = boolean | number | Vector3 | string | SharedTable | Instance | typeof SharedTableNominal;
1878
1880
  // SharedTable
1879
1881
  interface SharedTable {
1880
1882
  /**
@@ -1884,9 +1886,80 @@ interface SharedTable {
1884
1886
  * @hidden
1885
1887
  * @deprecated
1886
1888
  */
1887
- readonly _nominal_SharedTable: unique symbol;
1889
+ readonly _nominal_SharedTable: typeof SharedTableNominal;
1890
+ [K: string | number]: SharedTableValue;
1888
1891
  }
1889
1892
 
1893
+ interface SharedTableConstructor {
1894
+ /** Returns a new, empty SharedTable. */
1895
+ new (): SharedTable;
1896
+ /** Returns a new SharedTable containing elements equivalent to those in the provided object. */
1897
+ new (t: object): SharedTable;
1898
+ /** Removes all of the elements from the SharedTable. */
1899
+ clear: (st: SharedTable) => void;
1900
+ /**
1901
+ * Creates a clone of a SharedTable and returns the clone.
1902
+ *
1903
+ * If the optional deep argument is not present, or if it is present and its value is false, then a shallow clone is created.
1904
+ * A shallow clone copies only the top-level SharedTable object. If any value in the SharedTable itself is a SharedTable, then both the original SharedTable and the clone SharedTable will refer to the same SharedTable.
1905
+ *
1906
+ * The shallow clone operation is atomic, so the clone SharedTable will contain a consistent snapshot of the state in the original SharedTable, even if it is being modified concurrently from other scripts.
1907
+ *
1908
+ * If the optional deep argument is present and its value is true, then a deep clone is created.
1909
+ * A deep clone recursively copies a structure of SharedTable objects, such that there is no state shared between the original SharedTable and the clone.
1910
+ *
1911
+ * The clone of each SharedTable within the graph of SharedTable objects is atomic, but the deep clone as a whole is not atomic.
1912
+ * Thus, the clone of each SharedTable within the graph will contain a consistent snapshot of the state of the original SharedTable object from which it was cloned, but the states of different SharedTable objects may be inconsistent if the graph is being modified concurrently from other scripts.
1913
+ *
1914
+ * The SharedTable object(s) being cloned may be frozen (read-only) or not.
1915
+ * Regardless, the newly created clones are not frozen (and are thus modifiable).
1916
+ * To create frozen clones, use the SharedTable.cloneAndFreeze function.
1917
+ */
1918
+ clone: (st: SharedTable, deep?: boolean) => SharedTable;
1919
+ /**
1920
+ * Creates a frozen (read-only) clone of a SharedTable and returns the clone.
1921
+ * The behavior of this function is the same as the behavior of clone, except that the clone is frozen.
1922
+ *
1923
+ * If a deep clone is requested, then all of the cloned SharedTable objects are frozen.
1924
+ */
1925
+ cloneAndFreeze: (st: SharedTable, deep?: boolean) => SharedTable;
1926
+ /**
1927
+ * Atomically increments the value of an element.
1928
+ * An element with the specified key must exist in the SharedTable, and it must be of type number.
1929
+ * The specified delta is added to the value, and the original value is returned.
1930
+ *
1931
+ * The SharedTable.update function can also be used for this purpose; this increment function exists for convenience and performance.
1932
+ * In general, increment is much faster than update, so it should be preferred where possible.
1933
+ */
1934
+ increment: (st: SharedTable, k: string | number, delta: number) => number;
1935
+ /** Returns true if the SharedTable is frozen (read-only). */
1936
+ isFrozen: (st: SharedTable) => boolean;
1937
+ /**
1938
+ * Returns the number of elements stored in the SharedTable.
1939
+ * Note that if other scripts are concurrently modifying the SharedTable, the returned size may no longer be correct after it is returned, since other scripts may have added or removed elements from the SharedTable.
1940
+ */
1941
+ size: (st: SharedTable) => number;
1942
+ /**
1943
+ * Atomically updates the value of an element.
1944
+ *
1945
+ * When a SharedTable is accessed concurrently from scripts running in different execution contexts, it is possible for their accesses to interleave unpredictably.
1946
+ * Because of this, code like the following is generally incorrect, because the value may have changed between the read on the first line and the update on the second line:
1947
+ * ```ts
1948
+ * const oldValue = st["x"];
1949
+ * st["x"] = oldValue + ",x";
1950
+ * ```
1951
+ * The update function makes it possible to perform an atomic update to an element.
1952
+ * It takes a function that it will call with the current value of the element.
1953
+ * The function can then compute and return the new value.
1954
+ * Note that the function may be called multiple times if the SharedTable is being concurrently modified from other scripts.
1955
+ *
1956
+ * If the SharedTable is frozen, the operation fails and an error will be raised.
1957
+ */
1958
+ update: (st: SharedTable, k: string | number, f: (v: SharedTableValue) => SharedTableValue) => void;
1959
+ }
1960
+
1961
+ declare const SharedTable: SharedTableConstructor;
1962
+
1890
1963
  // TextChatMessage
1891
1964
  interface TextChatMessage {
1892
1965
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.689",
3
+ "version": "1.0.691",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },