@rbxts/types 1.0.852 → 1.0.854

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.
@@ -362,6 +362,7 @@ interface CreatableInstances {
362
362
  Glue: Glue;
363
363
  GroundController: GroundController;
364
364
  Handles: Handles;
365
+ HandRigDescription: HandRigDescription;
365
366
  HapticEffect: HapticEffect;
366
367
  Hat: Hat;
367
368
  HiddenSurfaceRemovalAsset: HiddenSurfaceRemovalAsset;
@@ -743,6 +744,7 @@ interface Objects extends Instances {
743
744
  EditableMesh: EditableMesh;
744
745
  Object: RBXObject;
745
746
  ScreenshotCapture: ScreenshotCapture;
747
+ VideoCapture: VideoCapture;
746
748
  }
747
749
  // GENERATED ROBLOX INSTANCE CLASSES
748
750
  /**
@@ -792,6 +794,21 @@ interface ScreenshotCapture extends Capture {
792
794
  */
793
795
  readonly _nominal_ScreenshotCapture: unique symbol;
794
796
  }
797
+ /**
798
+ * - **Tags**: NotCreatable, NotReplicated
799
+ *
800
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCapture)
801
+ */
802
+ interface VideoCapture extends Capture {
803
+ /**
804
+ * **DO NOT USE!**
805
+ *
806
+ * This field exists to force TypeScript to recognize this as a nominal type
807
+ * @hidden
808
+ * @deprecated
809
+ */
810
+ readonly _nominal_VideoCapture: unique symbol;
811
+ }
795
812
  /**
796
813
  * - **Tags**: NotCreatable, NotReplicated
797
814
  *
@@ -2492,9 +2509,9 @@ interface BindableFunction<T extends Callback = Callback> extends Instance {
2492
2509
  readonly _nominal_BindableFunction: unique symbol;
2493
2510
  }
2494
2511
  /**
2495
- * **Deprecated:** This class has been deprecated. Use `Constraints|Constraint` for new work. Find an overview of BodyMover replacements in the [Constraint Movers article](../../../physics/mover-constraints.md).
2512
+ * **Deprecated:** This class has been deprecated. See the [mover constraints](../../../physics/mover-constraints.md) article for an overview of `BodyMover` replacements, as well as the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2496
2513
  *
2497
- * Base class for objects that continually exert forces to parts.
2514
+ * Base class for objects that continually exert forces to assemblies.
2498
2515
  *
2499
2516
  * - **Tags**: NotCreatable
2500
2517
  *
@@ -2513,7 +2530,7 @@ interface BodyMover extends Instance {
2513
2530
  readonly _nominal_BodyMover: unique symbol;
2514
2531
  }
2515
2532
  /**
2516
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `AngularVelocity` instead.
2533
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `AngularVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2517
2534
  *
2518
2535
  * Applies a torque to maintain a constant angular velocity.
2519
2536
  *
@@ -2534,7 +2551,7 @@ interface BodyAngularVelocity extends BodyMover {
2534
2551
  readonly _nominal_BodyAngularVelocity: unique symbol;
2535
2552
  }
2536
2553
  /**
2537
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead.
2554
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2538
2555
  *
2539
2556
  * Applies a constant force to an object.
2540
2557
  *
@@ -2555,7 +2572,7 @@ interface BodyForce extends BodyMover {
2555
2572
  readonly _nominal_BodyForce: unique symbol;
2556
2573
  }
2557
2574
  /**
2558
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignOrientation` instead.
2575
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignOrientation` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2559
2576
  *
2560
2577
  * Applies a torque to maintain a constant orientation.
2561
2578
  *
@@ -2576,7 +2593,7 @@ interface BodyGyro extends BodyMover {
2576
2593
  readonly _nominal_BodyGyro: unique symbol;
2577
2594
  }
2578
2595
  /**
2579
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead.
2596
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `AlignPosition` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2580
2597
  *
2581
2598
  * Applies a force to maintain a constant position.
2582
2599
  *
@@ -2597,7 +2614,7 @@ interface BodyPosition extends BodyMover {
2597
2614
  readonly _nominal_BodyPosition: unique symbol;
2598
2615
  }
2599
2616
  /**
2600
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead.
2617
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `VectorForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2601
2618
  *
2602
2619
  * Applies a constant force to an object at a specific point.
2603
2620
  *
@@ -2618,7 +2635,7 @@ interface BodyThrust extends BodyMover {
2618
2635
  readonly _nominal_BodyThrust: unique symbol;
2619
2636
  }
2620
2637
  /**
2621
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead.
2638
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `LinearVelocity` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2622
2639
  *
2623
2640
  * Applies a force to maintain a constant velocity.
2624
2641
  *
@@ -2639,9 +2656,9 @@ interface BodyVelocity extends BodyMover {
2639
2656
  readonly _nominal_BodyVelocity: unique symbol;
2640
2657
  }
2641
2658
  /**
2642
- * **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead.
2659
+ * **Deprecated:** This object is deprecated and should not be used for new work. Use `LineForce` instead, and see the [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
2643
2660
  *
2644
- * Applies a force so that a part follows and faces another part.
2661
+ * Applies a force so that an assembly follows and faces a target part.
2645
2662
  *
2646
2663
  * - **Tags**:
2647
2664
  *
@@ -3175,6 +3192,8 @@ interface CommandService extends Instance {
3175
3192
  readonly _nominal_CommandService: unique symbol;
3176
3193
  }
3177
3194
  /**
3195
+ * Supports real-world purchases that you can bundle with digital benefits.
3196
+ *
3178
3197
  * - **Tags**: NotCreatable, Service
3179
3198
  *
3180
3199
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService)
@@ -3297,7 +3316,7 @@ interface AlignPosition extends Constraint {
3297
3316
  readonly _nominal_AlignPosition: unique symbol;
3298
3317
  }
3299
3318
  /**
3300
- * Applies torque on an assembly to maintain a **constant** angular velocity.
3319
+ * Applies torque on an assembly to maintain a constant angular velocity.
3301
3320
  *
3302
3321
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AngularVelocity)
3303
3322
  */
@@ -3372,7 +3391,7 @@ interface LineForce extends Constraint {
3372
3391
  readonly _nominal_LineForce: unique symbol;
3373
3392
  }
3374
3393
  /**
3375
- * Applies force on an assembly to maintain a **constant** linear velocity.
3394
+ * Applies force on an assembly to maintain a constant linear velocity.
3376
3395
  *
3377
3396
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LinearVelocity)
3378
3397
  */
@@ -6472,6 +6491,21 @@ interface GuiService extends Instance {
6472
6491
  */
6473
6492
  readonly _nominal_GuiService: unique symbol;
6474
6493
  }
6494
+ /**
6495
+ * - **Tags**: NotBrowsable
6496
+ *
6497
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HandRigDescription)
6498
+ */
6499
+ interface HandRigDescription extends Instance {
6500
+ /**
6501
+ * **DO NOT USE!**
6502
+ *
6503
+ * This field exists to force TypeScript to recognize this as a nominal type
6504
+ * @hidden
6505
+ * @deprecated
6506
+ */
6507
+ readonly _nominal_HandRigDescription: unique symbol;
6508
+ }
6475
6509
  /**
6476
6510
  * - **Tags**: NotBrowsable
6477
6511
  *
@@ -6661,6 +6695,8 @@ interface HumanoidDescription extends Instance {
6661
6695
  readonly _nominal_HumanoidDescription: unique symbol;
6662
6696
  }
6663
6697
  /**
6698
+ * - **Tags**: NotBrowsable
6699
+ *
6664
6700
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
6665
6701
  */
6666
6702
  interface HumanoidRigDescription extends Instance {
@@ -7808,6 +7844,12 @@ interface MaterialVariant extends Instance {
7808
7844
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#ColorMap)
7809
7845
  */
7810
7846
  ColorMap: ContentId;
7847
+ /**
7848
+ * - **ThreadSafety**: ReadSafe
7849
+ *
7850
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#ColorMapContent)
7851
+ */
7852
+ ColorMapContent: Content;
7811
7853
  /**
7812
7854
  * Determines which parts of the surface are metal and are non-metal.
7813
7855
  *
@@ -7816,6 +7858,12 @@ interface MaterialVariant extends Instance {
7816
7858
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#MetalnessMap)
7817
7859
  */
7818
7860
  MetalnessMap: ContentId;
7861
+ /**
7862
+ * - **ThreadSafety**: ReadSafe
7863
+ *
7864
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#MetalnessMapContent)
7865
+ */
7866
+ MetalnessMapContent: Content;
7819
7867
  /**
7820
7868
  * Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.
7821
7869
  *
@@ -7824,6 +7872,12 @@ interface MaterialVariant extends Instance {
7824
7872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#NormalMap)
7825
7873
  */
7826
7874
  NormalMap: ContentId;
7875
+ /**
7876
+ * - **ThreadSafety**: ReadSafe
7877
+ *
7878
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#NormalMapContent)
7879
+ */
7880
+ NormalMapContent: Content;
7827
7881
  /**
7828
7882
  * Determines the apparent roughness across the surface.
7829
7883
  *
@@ -7832,6 +7886,12 @@ interface MaterialVariant extends Instance {
7832
7886
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#RoughnessMap)
7833
7887
  */
7834
7888
  RoughnessMap: ContentId;
7889
+ /**
7890
+ * - **ThreadSafety**: ReadSafe
7891
+ *
7892
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#RoughnessMapContent)
7893
+ */
7894
+ RoughnessMapContent: Content;
7835
7895
  }
7836
7896
  /**
7837
7897
  * - **Tags**: NotCreatable, NotReplicated
@@ -11747,7 +11807,7 @@ interface DataModel extends ServiceProvider<Services> {
11747
11807
  */
11748
11808
  GetObjects(this: DataModel, url: ContentId): Array<Instance>;
11749
11809
  /**
11750
- * Sets the `DataModel.PlaceId` of the current game instance to the given *placeId*.
11810
+ * Sets the `DataModel.PlaceId` of the current game instance.
11751
11811
  *
11752
11812
  * - **ThreadSafety**: Unsafe
11753
11813
  *
@@ -11757,7 +11817,7 @@ interface DataModel extends ServiceProvider<Services> {
11757
11817
  */
11758
11818
  SetPlaceId(this: DataModel, placeId: number): void;
11759
11819
  /**
11760
- * Sets the `DataModel.GameId` of the current game instance to the given *universeId*.
11820
+ * Sets the `DataModel.GameId` of the current game instance to the given `universeId`.
11761
11821
  *
11762
11822
  * - **ThreadSafety**: Unsafe
11763
11823
  *
@@ -13218,6 +13278,12 @@ interface TerrainDetail extends Instance {
13218
13278
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#ColorMap)
13219
13279
  */
13220
13280
  ColorMap: ContentId;
13281
+ /**
13282
+ * - **ThreadSafety**: ReadSafe
13283
+ *
13284
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#ColorMapContent)
13285
+ */
13286
+ ColorMapContent: Content;
13221
13287
  /**
13222
13288
  * Determines which parts of the surface are metal and are non-metal.
13223
13289
  *
@@ -13226,6 +13292,12 @@ interface TerrainDetail extends Instance {
13226
13292
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#MetalnessMap)
13227
13293
  */
13228
13294
  MetalnessMap: ContentId;
13295
+ /**
13296
+ * - **ThreadSafety**: ReadSafe
13297
+ *
13298
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#MetalnessMapContent)
13299
+ */
13300
+ MetalnessMapContent: Content;
13229
13301
  /**
13230
13302
  * Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.
13231
13303
  *
@@ -13234,6 +13306,12 @@ interface TerrainDetail extends Instance {
13234
13306
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#NormalMap)
13235
13307
  */
13236
13308
  NormalMap: ContentId;
13309
+ /**
13310
+ * - **ThreadSafety**: ReadSafe
13311
+ *
13312
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#NormalMapContent)
13313
+ */
13314
+ NormalMapContent: Content;
13237
13315
  /**
13238
13316
  * Determines the apparent roughness across the surface.
13239
13317
  *
@@ -13242,6 +13320,12 @@ interface TerrainDetail extends Instance {
13242
13320
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#RoughnessMap)
13243
13321
  */
13244
13322
  RoughnessMap: ContentId;
13323
+ /**
13324
+ * - **ThreadSafety**: ReadSafe
13325
+ *
13326
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#RoughnessMapContent)
13327
+ */
13328
+ RoughnessMapContent: Content;
13245
13329
  }
13246
13330
  /**
13247
13331
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion)