@rbxts/types 1.0.952 → 1.0.954

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.
@@ -83,6 +83,7 @@ interface Services {
83
83
  ExperienceStateCaptureService: ExperienceStateCaptureService;
84
84
  ExperienceStateRecordingService: ExperienceStateRecordingService;
85
85
  ExplorerServiceVisibilityService: ExplorerServiceVisibilityService;
86
+ ExternalIdentityService: ExternalIdentityService;
86
87
  FaceAnimatorService: FaceAnimatorService;
87
88
  FacialAgeEstimationService: FacialAgeEstimationService;
88
89
  FacialAnimationRecordingService: FacialAnimationRecordingService;
@@ -182,6 +183,7 @@ interface Services {
182
183
  ProcessInstancePhysicsService: ProcessInstancePhysicsService;
183
184
  ProximityPromptService: ProximityPromptService;
184
185
  PublishService: PublishService;
186
+ QueueService: QueueService;
185
187
  RecommendationService: RecommendationService;
186
188
  ReflectionService: ReflectionService;
187
189
  RemoteCommandService: RemoteCommandService;
@@ -227,7 +229,6 @@ interface Services {
227
229
  SlimReplicationService: SlimReplicationService;
228
230
  SlimService: SlimService;
229
231
  SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
230
- SnippetService: SnippetService;
231
232
  SocialService: SocialService;
232
233
  SoundService: SoundService;
233
234
  SoundShimService: SoundShimService;
@@ -302,6 +303,7 @@ interface CreatableInstances {
302
303
  Accoutrement: Accoutrement;
303
304
  Actor: Actor;
304
305
  AdGui: AdGui;
306
+ AdPlacement: AdPlacement;
305
307
  AdPortal: AdPortal;
306
308
  AirController: AirController;
307
309
  AlignOrientation: AlignOrientation;
@@ -792,6 +794,7 @@ interface Instances extends Services, CreatableInstances {
792
794
  SoundEffect: SoundEffect;
793
795
  StackFrame: StackFrame;
794
796
  StandardPages: StandardPages;
797
+ StandardQueue: StandardQueue;
795
798
  StarterCharacterScripts: StarterCharacterScripts;
796
799
  StarterPlayerScripts: StarterPlayerScripts;
797
800
  StatsItem: StatsItem;
@@ -1186,6 +1189,19 @@ interface ActivityHistoryEventService extends Instance {
1186
1189
  */
1187
1190
  readonly _nominal_ActivityHistoryEventService: unique symbol;
1188
1191
  }
1192
+ /**
1193
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement)
1194
+ */
1195
+ interface AdPlacement extends Instance {
1196
+ /**
1197
+ * **DO NOT USE!**
1198
+ *
1199
+ * This field exists to force TypeScript to recognize this as a nominal type
1200
+ * @hidden
1201
+ * @deprecated
1202
+ */
1203
+ readonly _nominal_AdPlacement: unique symbol;
1204
+ }
1189
1205
  /**
1190
1206
  * A portal that teleports players to a sponsored experience as part of immersive ads.
1191
1207
  *
@@ -2462,6 +2478,8 @@ interface BadgeService extends Instance {
2462
2478
  readonly _nominal_BadgeService: unique symbol;
2463
2479
  }
2464
2480
  /**
2481
+ * Base class for the configuration objects that control individual built-in `CoreGui` elements.
2482
+ *
2465
2483
  * - **Tags**: NotCreatable, NotReplicated
2466
2484
  *
2467
2485
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration)
@@ -2477,6 +2495,8 @@ interface BaseCoreGuiConfiguration extends Instance {
2477
2495
  readonly _nominal_BaseCoreGuiConfiguration: unique symbol;
2478
2496
  }
2479
2497
  /**
2498
+ * Controls the built-in captures view, the `CoreGui` element that lets players browse and manage screenshots and video captures they take within an experience.
2499
+ *
2480
2500
  * - **Tags**: NotCreatable, NotReplicated
2481
2501
  *
2482
2502
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration)
@@ -2492,6 +2512,8 @@ interface CapturesViewConfiguration extends BaseCoreGuiConfiguration {
2492
2512
  readonly _nominal_CapturesViewConfiguration: unique symbol;
2493
2513
  }
2494
2514
  /**
2515
+ * Controls the built-in player list, the `CoreGui` element that displays the players currently in the experience.
2516
+ *
2495
2517
  * - **Tags**: NotCreatable, NotReplicated
2496
2518
  *
2497
2519
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration)
@@ -2507,6 +2529,8 @@ interface PlayerListConfiguration extends BaseCoreGuiConfiguration {
2507
2529
  readonly _nominal_PlayerListConfiguration: unique symbol;
2508
2530
  }
2509
2531
  /**
2532
+ * Controls the built-in self view, the `CoreGui` element that shows a player a preview of their own character within an experience.
2533
+ *
2510
2534
  * - **Tags**: NotCreatable, NotReplicated
2511
2535
  *
2512
2536
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration)
@@ -4231,6 +4255,8 @@ interface Controller extends Instance {
4231
4255
  readonly _nominal_Controller: unique symbol;
4232
4256
  }
4233
4257
  /**
4258
+ * A `Controller` held within `ControllerService` that translates player input into movement for the user's character `Humanoid`.
4259
+ *
4234
4260
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidController)
4235
4261
  */
4236
4262
  interface HumanoidController extends Controller {
@@ -4244,6 +4270,8 @@ interface HumanoidController extends Controller {
4244
4270
  readonly _nominal_HumanoidController: unique symbol;
4245
4271
  }
4246
4272
  /**
4273
+ * Translates player input into throttle and steer axis values for a `SkateboardPlatform`.
4274
+ *
4247
4275
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardController)
4248
4276
  */
4249
4277
  interface SkateboardController extends Controller {
@@ -4257,6 +4285,8 @@ interface SkateboardController extends Controller {
4257
4285
  readonly _nominal_SkateboardController: unique symbol;
4258
4286
  }
4259
4287
  /**
4288
+ * An object responsible for translating a seated player's directional input into throttle and steering for a `VehicleSeat`.
4289
+ *
4260
4290
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleController)
4261
4291
  */
4262
4292
  interface VehicleController extends Controller {
@@ -5395,6 +5425,21 @@ interface Explosion extends Instance {
5395
5425
  */
5396
5426
  readonly _nominal_Explosion: unique symbol;
5397
5427
  }
5428
+ /**
5429
+ * - **Tags**: NotCreatable, Service, NotReplicated
5430
+ *
5431
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExternalIdentityService)
5432
+ */
5433
+ interface ExternalIdentityService extends Instance {
5434
+ /**
5435
+ * **DO NOT USE!**
5436
+ *
5437
+ * This field exists to force TypeScript to recognize this as a nominal type
5438
+ * @hidden
5439
+ * @deprecated
5440
+ */
5441
+ readonly _nominal_ExternalIdentityService: unique symbol;
5442
+ }
5398
5443
  /**
5399
5444
  * - **Tags**: NotCreatable, Service, NotReplicated
5400
5445
  *
@@ -7119,6 +7164,8 @@ interface HeatmapService extends Instance {
7119
7164
  readonly _nominal_HeatmapService: unique symbol;
7120
7165
  }
7121
7166
  /**
7167
+ * A Studio-only service that backs the Terrain Editor's heightmap import tool, converting heightmap and colormap images into voxel `Terrain`.
7168
+ *
7122
7169
  * - **Tags**: Service, NotReplicated
7123
7170
  *
7124
7171
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeightmapImporterService)
@@ -8196,6 +8243,8 @@ interface LogService extends Instance {
8196
8243
  readonly _nominal_LogService: unique symbol;
8197
8244
  }
8198
8245
  /**
8246
+ * Settings related to how the engine handles Luau, its dialect of Lua.
8247
+ *
8199
8248
  * - **Tags**: NotCreatable, Service, NotReplicated
8200
8249
  *
8201
8250
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuaSettings)
@@ -8568,6 +8617,8 @@ interface MaterialVariant extends Instance {
8568
8617
  RoughnessMapContent: Content;
8569
8618
  }
8570
8619
  /**
8620
+ * Represents a live binding created by `Bind()` on `MemStorageService` that runs a callback whenever a memory-storage key changes.
8621
+ *
8571
8622
  * - **Tags**: NotCreatable, NotReplicated
8572
8623
  *
8573
8624
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection)
@@ -8582,10 +8633,12 @@ interface MemStorageConnection extends Instance {
8582
8633
  */
8583
8634
  readonly _nominal_MemStorageConnection: unique symbol;
8584
8635
  /**
8636
+ * Ends the binding so its callback no longer runs when the associated memory-storage key changes.
8637
+ *
8585
8638
  * - **ThreadSafety**: Unsafe
8586
8639
  *
8587
8640
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection#Disconnect)
8588
- * @param this
8641
+ * @param this Represents a live binding created by `Bind()` on `MemStorageService` that runs a callback whenever a memory-storage key changes.
8589
8642
  */
8590
8643
  Disconnect(this: MemStorageConnection): void;
8591
8644
  }
@@ -8765,8 +8818,6 @@ interface MetaBreakpointManager extends Instance {
8765
8818
  readonly _nominal_MetaBreakpointManager: unique symbol;
8766
8819
  }
8767
8820
  /**
8768
- * A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
8769
- *
8770
8821
  * - **Tags**: NotCreatable, Service, NotReplicated
8771
8822
  *
8772
8823
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
@@ -9240,6 +9291,8 @@ interface BasePart extends PVInstance {
9240
9291
  readonly _nominal_BasePart: unique symbol;
9241
9292
  }
9242
9293
  /**
9294
+ * A type of `BasePart` that has a corner wedge shape.
9295
+ *
9243
9296
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CornerWedgePart)
9244
9297
  */
9245
9298
  interface CornerWedgePart extends BasePart {
@@ -9414,15 +9467,6 @@ interface TriangleMeshPart extends BasePart {
9414
9467
  * @deprecated
9415
9468
  */
9416
9469
  readonly _nominal_TriangleMeshPart: unique symbol;
9417
- /**
9418
- * Determines the level of detail the part's physics will adhere to its mesh.
9419
- *
9420
- * - **ThreadSafety**: ReadSafe
9421
- * - **Tags**: NotReplicated
9422
- *
9423
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionFidelity)
9424
- */
9425
- set CollisionFidelity(value: Enum.CollisionFidelity);
9426
9470
  /**
9427
9471
  * - **ThreadSafety**: ReadSafe
9428
9472
  * - **Tags**: NotReplicated
@@ -9430,15 +9474,6 @@ interface TriangleMeshPart extends BasePart {
9430
9474
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionPrecision)
9431
9475
  */
9432
9476
  set CollisionPrecision(value: number);
9433
- /**
9434
- * Determines the geometric representation used to compute aerodynamic forces and torques.
9435
- *
9436
- * - **ThreadSafety**: ReadSafe
9437
- * - **Tags**: NotReplicated
9438
- *
9439
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#FluidFidelity)
9440
- */
9441
- set FluidFidelity(value: Enum.FluidFidelity);
9442
9477
  }
9443
9478
  /**
9444
9479
  * A form of `BasePart` that includes a physically simulated custom mesh.
@@ -9478,22 +9513,6 @@ interface PartOperation extends TriangleMeshPart {
9478
9513
  * @deprecated
9479
9514
  */
9480
9515
  readonly _nominal_PartOperation: unique symbol;
9481
- /**
9482
- * The level of detail used to render the solid modeled part.
9483
- *
9484
- * - **ThreadSafety**: ReadSafe
9485
- *
9486
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#RenderFidelity)
9487
- */
9488
- set RenderFidelity(value: Enum.RenderFidelity);
9489
- /**
9490
- * An angle in degrees which affects the smooth shading of a solid modeled part.
9491
- *
9492
- * - **ThreadSafety**: ReadSafe
9493
- *
9494
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#SmoothingAngle)
9495
- */
9496
- set SmoothingAngle(value: number);
9497
9516
  }
9498
9517
  /**
9499
9518
  * Result of parts that have been intersected into a single solid model.
@@ -9762,6 +9781,8 @@ interface Workspace extends WorldRoot {
9762
9781
  /**
9763
9782
  * **Deprecated:** This property should not be used for new work.
9764
9783
  *
9784
+ * Deprecated setting that configured the interpolation throttling mode; it no longer takes effect.
9785
+ *
9765
9786
  * - **ThreadSafety**: ReadSafe
9766
9787
  * - **Tags**: Hidden, NotReplicated
9767
9788
  *
@@ -9837,7 +9858,7 @@ interface Workspace extends WorldRoot {
9837
9858
  ZoomToExtents(this: Workspace): void;
9838
9859
  }
9839
9860
  /**
9840
- * Extends limited physics for its children on to a parent `ViewportFrame`.
9861
+ * Extends limited physics to its children.
9841
9862
  *
9842
9863
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel)
9843
9864
  */
@@ -11982,6 +12003,21 @@ interface PublishService extends Instance {
11982
12003
  */
11983
12004
  readonly _nominal_PublishService: unique symbol;
11984
12005
  }
12006
+ /**
12007
+ * - **Tags**: NotCreatable, Service, NotReplicated
12008
+ *
12009
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/QueueService)
12010
+ */
12011
+ interface QueueService extends Instance {
12012
+ /**
12013
+ * **DO NOT USE!**
12014
+ *
12015
+ * This field exists to force TypeScript to recognize this as a nominal type
12016
+ * @hidden
12017
+ * @deprecated
12018
+ */
12019
+ readonly _nominal_QueueService: unique symbol;
12020
+ }
11985
12021
  /**
11986
12022
  * - **Tags**: NotReplicated
11987
12023
  *
@@ -12028,6 +12064,8 @@ interface RecommendationService extends Instance {
12028
12064
  readonly _nominal_RecommendationService: unique symbol;
12029
12065
  }
12030
12066
  /**
12067
+ * A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
12068
+ *
12031
12069
  * - **Tags**: NotCreatable, Service, NotReplicated
12032
12070
  *
12033
12071
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService)
@@ -13949,21 +13987,6 @@ interface SmoothVoxelsUpgraderService extends Instance {
13949
13987
  */
13950
13988
  readonly _nominal_SmoothVoxelsUpgraderService: unique symbol;
13951
13989
  }
13952
- /**
13953
- * - **Tags**: NotCreatable, Service, NotReplicated
13954
- *
13955
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SnippetService)
13956
- */
13957
- interface SnippetService extends Instance {
13958
- /**
13959
- * **DO NOT USE!**
13960
- *
13961
- * This field exists to force TypeScript to recognize this as a nominal type
13962
- * @hidden
13963
- * @deprecated
13964
- */
13965
- readonly _nominal_SnippetService: unique symbol;
13966
- }
13967
13990
  /**
13968
13991
  * Facilitates social functions that impact relationships made on the Roblox platform.
13969
13992
  *
@@ -14306,6 +14329,21 @@ interface StackFrame extends Instance {
14306
14329
  */
14307
14330
  readonly _nominal_StackFrame: unique symbol;
14308
14331
  }
14332
+ /**
14333
+ * - **Tags**: NotCreatable, NotReplicated
14334
+ *
14335
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue)
14336
+ */
14337
+ interface StandardQueue extends Instance {
14338
+ /**
14339
+ * **DO NOT USE!**
14340
+ *
14341
+ * This field exists to force TypeScript to recognize this as a nominal type
14342
+ * @hidden
14343
+ * @deprecated
14344
+ */
14345
+ readonly _nominal_StandardQueue: unique symbol;
14346
+ }
14309
14347
  /**
14310
14348
  * - **Tags**: NotCreatable, Service, NotReplicated
14311
14349
  *
@@ -14435,8 +14473,6 @@ interface StateMachineDefinition extends Instance {
14435
14473
  readonly _nominal_StateMachineDefinition: unique symbol;
14436
14474
  }
14437
14475
  /**
14438
- * - **Tags**: NotReplicated
14439
- *
14440
14476
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition)
14441
14477
  */
14442
14478
  interface StateMachineTransitionDefinition extends Instance {
@@ -14496,6 +14532,7 @@ interface StatsItem extends Instance {
14496
14532
  *
14497
14533
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValue)
14498
14534
  * @param this A single performance metric.
14535
+ * @returns The numeric value of the stats item.
14499
14536
  */
14500
14537
  GetValue(this: StatsItem): number;
14501
14538
  /**
@@ -14505,6 +14542,7 @@ interface StatsItem extends Instance {
14505
14542
  *
14506
14543
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValueString)
14507
14544
  * @param this A single performance metric.
14545
+ * @returns The value of the stats item formatted as a string.
14508
14546
  */
14509
14547
  GetValueString(this: StatsItem): string;
14510
14548
  }
@@ -14577,6 +14615,8 @@ interface TotalCountTimeIntervalItem extends StatsItem {
14577
14615
  readonly _nominal_TotalCountTimeIntervalItem: unique symbol;
14578
14616
  }
14579
14617
  /**
14618
+ * Represents Roblox Studio's script editor settings.
14619
+ *
14580
14620
  * - **Tags**: NotCreatable, Service, NotReplicated
14581
14621
  *
14582
14622
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Studio)
@@ -15507,7 +15547,7 @@ interface Studio extends Instance {
15507
15547
  * - **ThreadSafety**: Unsafe
15508
15548
  *
15509
15549
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Studio#GetAvailableThemes)
15510
- * @param this
15550
+ * @param this Represents Roblox Studio's script editor settings.
15511
15551
  * @returns A list of themes available in Studio.
15512
15552
  */
15513
15553
  GetAvailableThemes(this: Studio): Array<unknown>;
@@ -16752,6 +16792,8 @@ interface TerrainDetail extends Instance {
16752
16792
  RoughnessMapContent: Content;
16753
16793
  }
16754
16794
  /**
16795
+ * An object that stores a chunk of terrain voxel data, produced by `Terrain:CopyRegion()` and consumed by `Terrain:PasteRegion()`.
16796
+ *
16755
16797
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion)
16756
16798
  */
16757
16799
  interface TerrainRegion extends Instance {
@@ -16772,7 +16814,7 @@ interface TerrainRegion extends Instance {
16772
16814
  * - **Tags**:
16773
16815
  *
16774
16816
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion#ConvertToSmooth)
16775
- * @param this
16817
+ * @param this An object that stores a chunk of terrain voxel data, produced by `Terrain:CopyRegion()` and consumed by `Terrain:PasteRegion()`.
16776
16818
  *
16777
16819
  * @deprecated
16778
16820
  */