@rbxts/types 1.0.951 → 1.0.953

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;
@@ -302,6 +304,7 @@ interface CreatableInstances {
302
304
  Accoutrement: Accoutrement;
303
305
  Actor: Actor;
304
306
  AdGui: AdGui;
307
+ AdPlacement: AdPlacement;
305
308
  AdPortal: AdPortal;
306
309
  AirController: AirController;
307
310
  AlignOrientation: AlignOrientation;
@@ -792,6 +795,7 @@ interface Instances extends Services, CreatableInstances {
792
795
  SoundEffect: SoundEffect;
793
796
  StackFrame: StackFrame;
794
797
  StandardPages: StandardPages;
798
+ StandardQueue: StandardQueue;
795
799
  StarterCharacterScripts: StarterCharacterScripts;
796
800
  StarterPlayerScripts: StarterPlayerScripts;
797
801
  StatsItem: StatsItem;
@@ -1186,6 +1190,19 @@ interface ActivityHistoryEventService extends Instance {
1186
1190
  */
1187
1191
  readonly _nominal_ActivityHistoryEventService: unique symbol;
1188
1192
  }
1193
+ /**
1194
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement)
1195
+ */
1196
+ interface AdPlacement extends Instance {
1197
+ /**
1198
+ * **DO NOT USE!**
1199
+ *
1200
+ * This field exists to force TypeScript to recognize this as a nominal type
1201
+ * @hidden
1202
+ * @deprecated
1203
+ */
1204
+ readonly _nominal_AdPlacement: unique symbol;
1205
+ }
1189
1206
  /**
1190
1207
  * A portal that teleports players to a sponsored experience as part of immersive ads.
1191
1208
  *
@@ -2462,6 +2479,8 @@ interface BadgeService extends Instance {
2462
2479
  readonly _nominal_BadgeService: unique symbol;
2463
2480
  }
2464
2481
  /**
2482
+ * Base class for the configuration objects that control individual built-in `CoreGui` elements.
2483
+ *
2465
2484
  * - **Tags**: NotCreatable, NotReplicated
2466
2485
  *
2467
2486
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration)
@@ -2477,6 +2496,8 @@ interface BaseCoreGuiConfiguration extends Instance {
2477
2496
  readonly _nominal_BaseCoreGuiConfiguration: unique symbol;
2478
2497
  }
2479
2498
  /**
2499
+ * Controls the built-in captures view, the `CoreGui` element that lets players browse and manage screenshots and video captures they take within an experience.
2500
+ *
2480
2501
  * - **Tags**: NotCreatable, NotReplicated
2481
2502
  *
2482
2503
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration)
@@ -2492,6 +2513,8 @@ interface CapturesViewConfiguration extends BaseCoreGuiConfiguration {
2492
2513
  readonly _nominal_CapturesViewConfiguration: unique symbol;
2493
2514
  }
2494
2515
  /**
2516
+ * Controls the built-in player list, the `CoreGui` element that displays the players currently in the experience.
2517
+ *
2495
2518
  * - **Tags**: NotCreatable, NotReplicated
2496
2519
  *
2497
2520
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration)
@@ -2507,6 +2530,8 @@ interface PlayerListConfiguration extends BaseCoreGuiConfiguration {
2507
2530
  readonly _nominal_PlayerListConfiguration: unique symbol;
2508
2531
  }
2509
2532
  /**
2533
+ * Controls the built-in self view, the `CoreGui` element that shows a player a preview of their own character within an experience.
2534
+ *
2510
2535
  * - **Tags**: NotCreatable, NotReplicated
2511
2536
  *
2512
2537
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration)
@@ -4231,6 +4256,8 @@ interface Controller extends Instance {
4231
4256
  readonly _nominal_Controller: unique symbol;
4232
4257
  }
4233
4258
  /**
4259
+ * A `Controller` held within `ControllerService` that translates player input into movement for the user's character `Humanoid`.
4260
+ *
4234
4261
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidController)
4235
4262
  */
4236
4263
  interface HumanoidController extends Controller {
@@ -4244,6 +4271,8 @@ interface HumanoidController extends Controller {
4244
4271
  readonly _nominal_HumanoidController: unique symbol;
4245
4272
  }
4246
4273
  /**
4274
+ * Translates player input into throttle and steer axis values for a `SkateboardPlatform`.
4275
+ *
4247
4276
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardController)
4248
4277
  */
4249
4278
  interface SkateboardController extends Controller {
@@ -4257,6 +4286,8 @@ interface SkateboardController extends Controller {
4257
4286
  readonly _nominal_SkateboardController: unique symbol;
4258
4287
  }
4259
4288
  /**
4289
+ * An object responsible for translating a seated player's directional input into throttle and steering for a `VehicleSeat`.
4290
+ *
4260
4291
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleController)
4261
4292
  */
4262
4293
  interface VehicleController extends Controller {
@@ -5395,6 +5426,21 @@ interface Explosion extends Instance {
5395
5426
  */
5396
5427
  readonly _nominal_Explosion: unique symbol;
5397
5428
  }
5429
+ /**
5430
+ * - **Tags**: NotCreatable, Service, NotReplicated
5431
+ *
5432
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExternalIdentityService)
5433
+ */
5434
+ interface ExternalIdentityService extends Instance {
5435
+ /**
5436
+ * **DO NOT USE!**
5437
+ *
5438
+ * This field exists to force TypeScript to recognize this as a nominal type
5439
+ * @hidden
5440
+ * @deprecated
5441
+ */
5442
+ readonly _nominal_ExternalIdentityService: unique symbol;
5443
+ }
5398
5444
  /**
5399
5445
  * - **Tags**: NotCreatable, Service, NotReplicated
5400
5446
  *
@@ -7119,6 +7165,8 @@ interface HeatmapService extends Instance {
7119
7165
  readonly _nominal_HeatmapService: unique symbol;
7120
7166
  }
7121
7167
  /**
7168
+ * A Studio-only service that backs the Terrain Editor's heightmap import tool, converting heightmap and colormap images into voxel `Terrain`.
7169
+ *
7122
7170
  * - **Tags**: Service, NotReplicated
7123
7171
  *
7124
7172
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeightmapImporterService)
@@ -8196,6 +8244,8 @@ interface LogService extends Instance {
8196
8244
  readonly _nominal_LogService: unique symbol;
8197
8245
  }
8198
8246
  /**
8247
+ * Settings related to how the engine handles Luau, its dialect of Lua.
8248
+ *
8199
8249
  * - **Tags**: NotCreatable, Service, NotReplicated
8200
8250
  *
8201
8251
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LuaSettings)
@@ -8568,6 +8618,8 @@ interface MaterialVariant extends Instance {
8568
8618
  RoughnessMapContent: Content;
8569
8619
  }
8570
8620
  /**
8621
+ * Represents a live binding created by `Bind()` on `MemStorageService` that runs a callback whenever a memory-storage key changes.
8622
+ *
8571
8623
  * - **Tags**: NotCreatable, NotReplicated
8572
8624
  *
8573
8625
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection)
@@ -8582,10 +8634,12 @@ interface MemStorageConnection extends Instance {
8582
8634
  */
8583
8635
  readonly _nominal_MemStorageConnection: unique symbol;
8584
8636
  /**
8637
+ * Ends the binding so its callback no longer runs when the associated memory-storage key changes.
8638
+ *
8585
8639
  * - **ThreadSafety**: Unsafe
8586
8640
  *
8587
8641
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection#Disconnect)
8588
- * @param this
8642
+ * @param this Represents a live binding created by `Bind()` on `MemStorageService` that runs a callback whenever a memory-storage key changes.
8589
8643
  */
8590
8644
  Disconnect(this: MemStorageConnection): void;
8591
8645
  }
@@ -8765,8 +8819,6 @@ interface MetaBreakpointManager extends Instance {
8765
8819
  readonly _nominal_MetaBreakpointManager: unique symbol;
8766
8820
  }
8767
8821
  /**
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
8822
  * - **Tags**: NotCreatable, Service, NotReplicated
8771
8823
  *
8772
8824
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
@@ -9240,6 +9292,8 @@ interface BasePart extends PVInstance {
9240
9292
  readonly _nominal_BasePart: unique symbol;
9241
9293
  }
9242
9294
  /**
9295
+ * A type of `BasePart` that has a corner wedge shape.
9296
+ *
9243
9297
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CornerWedgePart)
9244
9298
  */
9245
9299
  interface CornerWedgePart extends BasePart {
@@ -9762,6 +9816,8 @@ interface Workspace extends WorldRoot {
9762
9816
  /**
9763
9817
  * **Deprecated:** This property should not be used for new work.
9764
9818
  *
9819
+ * Deprecated setting that configured the interpolation throttling mode; it no longer takes effect.
9820
+ *
9765
9821
  * - **ThreadSafety**: ReadSafe
9766
9822
  * - **Tags**: Hidden, NotReplicated
9767
9823
  *
@@ -9837,7 +9893,7 @@ interface Workspace extends WorldRoot {
9837
9893
  ZoomToExtents(this: Workspace): void;
9838
9894
  }
9839
9895
  /**
9840
- * Extends limited physics for its children on to a parent `ViewportFrame`.
9896
+ * Extends limited physics to its children.
9841
9897
  *
9842
9898
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel)
9843
9899
  */
@@ -11982,6 +12038,21 @@ interface PublishService extends Instance {
11982
12038
  */
11983
12039
  readonly _nominal_PublishService: unique symbol;
11984
12040
  }
12041
+ /**
12042
+ * - **Tags**: NotCreatable, Service, NotReplicated
12043
+ *
12044
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/QueueService)
12045
+ */
12046
+ interface QueueService extends Instance {
12047
+ /**
12048
+ * **DO NOT USE!**
12049
+ *
12050
+ * This field exists to force TypeScript to recognize this as a nominal type
12051
+ * @hidden
12052
+ * @deprecated
12053
+ */
12054
+ readonly _nominal_QueueService: unique symbol;
12055
+ }
11985
12056
  /**
11986
12057
  * - **Tags**: NotReplicated
11987
12058
  *
@@ -12028,6 +12099,8 @@ interface RecommendationService extends Instance {
12028
12099
  readonly _nominal_RecommendationService: unique symbol;
12029
12100
  }
12030
12101
  /**
12102
+ * A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
12103
+ *
12031
12104
  * - **Tags**: NotCreatable, Service, NotReplicated
12032
12105
  *
12033
12106
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService)
@@ -14306,6 +14379,21 @@ interface StackFrame extends Instance {
14306
14379
  */
14307
14380
  readonly _nominal_StackFrame: unique symbol;
14308
14381
  }
14382
+ /**
14383
+ * - **Tags**: NotCreatable, NotReplicated
14384
+ *
14385
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue)
14386
+ */
14387
+ interface StandardQueue extends Instance {
14388
+ /**
14389
+ * **DO NOT USE!**
14390
+ *
14391
+ * This field exists to force TypeScript to recognize this as a nominal type
14392
+ * @hidden
14393
+ * @deprecated
14394
+ */
14395
+ readonly _nominal_StandardQueue: unique symbol;
14396
+ }
14309
14397
  /**
14310
14398
  * - **Tags**: NotCreatable, Service, NotReplicated
14311
14399
  *
@@ -14435,8 +14523,6 @@ interface StateMachineDefinition extends Instance {
14435
14523
  readonly _nominal_StateMachineDefinition: unique symbol;
14436
14524
  }
14437
14525
  /**
14438
- * - **Tags**: NotReplicated
14439
- *
14440
14526
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition)
14441
14527
  */
14442
14528
  interface StateMachineTransitionDefinition extends Instance {
@@ -14496,6 +14582,7 @@ interface StatsItem extends Instance {
14496
14582
  *
14497
14583
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValue)
14498
14584
  * @param this A single performance metric.
14585
+ * @returns The numeric value of the stats item.
14499
14586
  */
14500
14587
  GetValue(this: StatsItem): number;
14501
14588
  /**
@@ -14505,6 +14592,7 @@ interface StatsItem extends Instance {
14505
14592
  *
14506
14593
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValueString)
14507
14594
  * @param this A single performance metric.
14595
+ * @returns The value of the stats item formatted as a string.
14508
14596
  */
14509
14597
  GetValueString(this: StatsItem): string;
14510
14598
  }
@@ -14577,6 +14665,8 @@ interface TotalCountTimeIntervalItem extends StatsItem {
14577
14665
  readonly _nominal_TotalCountTimeIntervalItem: unique symbol;
14578
14666
  }
14579
14667
  /**
14668
+ * Represents Roblox Studio's script editor settings.
14669
+ *
14580
14670
  * - **Tags**: NotCreatable, Service, NotReplicated
14581
14671
  *
14582
14672
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Studio)
@@ -15507,7 +15597,7 @@ interface Studio extends Instance {
15507
15597
  * - **ThreadSafety**: Unsafe
15508
15598
  *
15509
15599
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Studio#GetAvailableThemes)
15510
- * @param this
15600
+ * @param this Represents Roblox Studio's script editor settings.
15511
15601
  * @returns A list of themes available in Studio.
15512
15602
  */
15513
15603
  GetAvailableThemes(this: Studio): Array<unknown>;
@@ -16752,6 +16842,8 @@ interface TerrainDetail extends Instance {
16752
16842
  RoughnessMapContent: Content;
16753
16843
  }
16754
16844
  /**
16845
+ * An object that stores a chunk of terrain voxel data, produced by `Terrain:CopyRegion()` and consumed by `Terrain:PasteRegion()`.
16846
+ *
16755
16847
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion)
16756
16848
  */
16757
16849
  interface TerrainRegion extends Instance {
@@ -16772,7 +16864,7 @@ interface TerrainRegion extends Instance {
16772
16864
  * - **Tags**:
16773
16865
  *
16774
16866
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion#ConvertToSmooth)
16775
- * @param this
16867
+ * @param this An object that stores a chunk of terrain voxel data, produced by `Terrain:CopyRegion()` and consumed by `Terrain:PasteRegion()`.
16776
16868
  *
16777
16869
  * @deprecated
16778
16870
  */