@rbxts/types 1.0.901 → 1.0.902

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.
@@ -811,7 +811,7 @@ interface AnimationNode extends RBXObject {
811
811
  readonly _nominal_AnimationNode: unique symbol;
812
812
  }
813
813
  /**
814
- * A class which defines a piece of content, such as a screnshot or video, taken in-experience.
814
+ * A class which defines a piece of content, such as a screenshot or video, taken in-experience.
815
815
  *
816
816
  * - **Tags**: NotCreatable, NotReplicated
817
817
  *
@@ -2930,13 +2930,15 @@ interface AdService extends Instance {
2930
2930
  */
2931
2931
  GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): unknown;
2932
2932
  /**
2933
+ * Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad.
2934
+ *
2933
2935
  * - **ThreadSafety**: Unsafe
2934
2936
  * - **Tags**: Yields
2935
2937
  *
2936
2938
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
2937
2939
  * @param this A class that allows the display of mobile video ads.
2938
2940
  * @param instance
2939
- * @param placementId
2941
+ * @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
2940
2942
  */
2941
2943
  RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
2942
2944
  /**
@@ -7623,14 +7625,7 @@ interface AvatarCreationService extends Instance {
7623
7625
  * @param progressCallback Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: `(progressInfo: { Progress: number }) -> ()`
7624
7626
  * @returns A unique identifier for the generated avatar.
7625
7627
  */
7626
- AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, model: Model, progressCallback?: Callback): string;
7627
- /**
7628
- * - **ThreadSafety**: Unsafe
7629
- * - **Tags**: Yields
7630
- *
7631
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarNewAsync)
7632
- */
7633
- AutoSetupAvatarNewAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
7628
+ AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
7634
7629
  /**
7635
7630
  * Creates a 2D avatar preview and returns a previewId.
7636
7631
  *
@@ -8063,6 +8058,13 @@ interface AvatarEditorService extends Instance {
8063
8058
  * @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
8064
8059
  */
8065
8060
  GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
8061
+ /**
8062
+ * - **ThreadSafety**: Unsafe
8063
+ * - **Tags**: Yields
8064
+ *
8065
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
8066
+ */
8067
+ GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
8066
8068
  /**
8067
8069
  * **Deprecated:**
8068
8070
  *
@@ -8485,7 +8487,7 @@ interface BadgeService extends Instance {
8485
8487
  */
8486
8488
  IsLegal(this: BadgeService, badgeId: number): boolean;
8487
8489
  /**
8488
- * **Deprecated:** This function has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
8490
+ * **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
8489
8491
  *
8490
8492
  * Checks whether a user has the badge given the `Player.UserId` and the badge ID.
8491
8493
  *
@@ -10493,12 +10495,9 @@ interface CaptureService extends Instance {
10493
10495
  /**
10494
10496
  * - **ThreadSafety**: Unsafe
10495
10497
  *
10496
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeCapture)
10497
- * @param this A service which provides control over screenshot and video capture features.
10498
- * @param onCaptureReady
10499
- * @param captureParams
10498
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeScreenshotCaptureAsync)
10500
10499
  */
10501
- TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
10500
+ TakeScreenshotCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
10502
10501
  /**
10503
10502
  * - **ThreadSafety**: Unsafe
10504
10503
  * - **Tags**: Yields
@@ -24984,7 +24983,7 @@ interface InputAction extends Instance {
24984
24983
  /**
24985
24984
  * Returns the current state of the `InputAction`.
24986
24985
  *
24987
- * - **ThreadSafety**: Unsafe
24986
+ * - **ThreadSafety**: Safe
24988
24987
  *
24989
24988
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#GetState)
24990
24989
  * @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
@@ -28126,6 +28125,8 @@ interface MaterialVariant extends Instance {
28126
28125
  */
28127
28126
  readonly _nominal_MaterialVariant: unique symbol;
28128
28127
  /**
28128
+ * Determines how the alpha channel of the `MaterialVariant.ColorMap` is used.
28129
+ *
28129
28130
  * - **ThreadSafety**: ReadSafe
28130
28131
  * - **Tags**: NotBrowsable
28131
28132
  *
@@ -34826,7 +34827,7 @@ interface Player extends Instance {
34826
34827
  */
34827
34828
  GetRoleInGroupAsync(this: Player, groupId: number): string;
34828
34829
  /**
34829
- * **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
34830
+ * **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use `Player:IsFriendsWithAsync()` instead.
34830
34831
  *
34831
34832
  * Returns whether a player is connections with the specified user.
34832
34833
  *
@@ -34841,7 +34842,7 @@ interface Player extends Instance {
34841
34842
  */
34842
34843
  IsBestFriendsWith(this: Player, userId: number): boolean;
34843
34844
  /**
34844
- * **Deprecated:**
34845
+ * **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
34845
34846
  *
34846
34847
  * Checks whether a player is a connection of the user with the given `Player.UserId`.
34847
34848
  *
@@ -41280,12 +41281,6 @@ interface StyleQuery extends Instance {
41280
41281
  * @deprecated
41281
41282
  */
41282
41283
  readonly _nominal_StyleQuery: unique symbol;
41283
- /**
41284
- * - **ThreadSafety**: ReadSafe
41285
- *
41286
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#AspectRatioRange)
41287
- */
41288
- AspectRatioRange: NumberRange;
41289
41284
  /**
41290
41285
  * - **ThreadSafety**: ReadSafe
41291
41286
  * - **Tags**: NotReplicated
@@ -41293,12 +41288,6 @@ interface StyleQuery extends Instance {
41293
41288
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
41294
41289
  */
41295
41290
  readonly IsActive: boolean;
41296
- /**
41297
- * - **ThreadSafety**: ReadSafe
41298
- *
41299
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MinSize)
41300
- */
41301
- MinSize: Vector2;
41302
41291
  /**
41303
41292
  * - **ThreadSafety**: Unsafe
41304
41293
  *
@@ -42096,7 +42085,7 @@ interface TestService extends Instance {
42096
42085
  */
42097
42086
  readonly _nominal_TestService: unique symbol;
42098
42087
  /**
42099
- * If set to true, the game will start running when the TestService's `TestService:Run()` method is called.
42088
+ * If set to `true`, the game will start running when the service's `TestService:Run()` method is called.
42100
42089
  *
42101
42090
  * - **ThreadSafety**: ReadSafe
42102
42091
  *
@@ -42121,7 +42110,7 @@ interface TestService extends Instance {
42121
42110
  */
42122
42111
  readonly ErrorCount: number;
42123
42112
  /**
42124
- * When set to true, the TestService will be executed when using the *Run* action in Roblox Studio.
42113
+ * When set to `true`, `TestService` will be executed when using the **Run** action in Roblox Studio.
42125
42114
  *
42126
42115
  * - **ThreadSafety**: ReadSafe
42127
42116
  *
@@ -42208,7 +42197,7 @@ interface TestService extends Instance {
42208
42197
  */
42209
42198
  readonly WarnCount: number;
42210
42199
  /**
42211
- * Prints result of condition to output.
42200
+ * Prints result of a condition to the output.
42212
42201
  *
42213
42202
  * - **ThreadSafety**: Unsafe
42214
42203
  *
@@ -42221,7 +42210,7 @@ interface TestService extends Instance {
42221
42210
  */
42222
42211
  Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
42223
42212
  /**
42224
- * Prints "Test checkpoint: ", followed by text, to the output, in blue text.
42213
+ * Prints `Test checkpoint:` followed by a string to the output in blue text.
42225
42214
  *
42226
42215
  * - **ThreadSafety**: Unsafe
42227
42216
  *
@@ -42233,7 +42222,7 @@ interface TestService extends Instance {
42233
42222
  */
42234
42223
  Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
42235
42224
  /**
42236
- * Prints Testing Done to the output, in blue text.
42225
+ * Prints `Testing Done` to the output in blue text.
42237
42226
  *
42238
42227
  * - **ThreadSafety**: Unsafe
42239
42228
  *
@@ -42242,7 +42231,7 @@ interface TestService extends Instance {
42242
42231
  */
42243
42232
  Done(this: TestService): void;
42244
42233
  /**
42245
- * Prints a red message to the output, prefixed by `TestService:`.
42234
+ * Prints a red error message to the output, prefixed by `TestService:`.
42246
42235
  *
42247
42236
  * - **ThreadSafety**: Unsafe
42248
42237
  *
@@ -42254,7 +42243,7 @@ interface TestService extends Instance {
42254
42243
  */
42255
42244
  Error(this: TestService, description: string, source?: Instance, line?: number): void;
42256
42245
  /**
42257
- * Indicates a fatal error in a TestService run. If this is called inside of a script running inside of the TestService, this will initiate a breakpoint on the line that invoked the error.
42246
+ * Indicates a fatal error in a `TestService` run.
42258
42247
  *
42259
42248
  * - **ThreadSafety**: Unsafe
42260
42249
  *
@@ -42266,7 +42255,7 @@ interface TestService extends Instance {
42266
42255
  */
42267
42256
  Fail(this: TestService, description: string, source?: Instance, line?: number): void;
42268
42257
  /**
42269
- * Prints Test message, followed by text to the output, in blue text.
42258
+ * Prints `TestService:` followed by a string to the output in blue text.
42270
42259
  *
42271
42260
  * - **ThreadSafety**: Unsafe
42272
42261
  *
@@ -42278,7 +42267,7 @@ interface TestService extends Instance {
42278
42267
  */
42279
42268
  Message(this: TestService, text: string, source?: Instance, line?: number): void;
42280
42269
  /**
42281
- * Prints whether a condition is true along with description text.
42270
+ * Prints whether a condition is true along with a description string.
42282
42271
  *
42283
42272
  * - **ThreadSafety**: Unsafe
42284
42273
  *
@@ -42306,7 +42295,7 @@ interface TestService extends Instance {
42306
42295
  */
42307
42296
  TakeSnapshot(this: TestService, snapshotname: string): void;
42308
42297
  /**
42309
- * Prints if a condition is true, otherwise prints a warning.
42298
+ * Prints if a condition is `true`, otherwise prints a warning.
42310
42299
  *
42311
42300
  * - **ThreadSafety**: Unsafe
42312
42301
  *
@@ -42327,7 +42316,7 @@ interface TestService extends Instance {
42327
42316
  */
42328
42317
  isFeatureEnabled(this: TestService, name: string): boolean;
42329
42318
  /**
42330
- * Fired when the server should collect a conditional test result.
42319
+ * Fires when the server should collect a conditional test result.
42331
42320
  *
42332
42321
  * - **ThreadSafety**: Unsafe
42333
42322
  *
@@ -42335,7 +42324,7 @@ interface TestService extends Instance {
42335
42324
  */
42336
42325
  readonly ServerCollectConditionalResult: RBXScriptSignal<(condition: boolean, text: string, script: Instance, line: number) => void>;
42337
42326
  /**
42338
- * Fired when the server should collect a test result.
42327
+ * Fires when the server should collect a test result.
42339
42328
  *
42340
42329
  * - **ThreadSafety**: Unsafe
42341
42330
  *
@@ -823,7 +823,7 @@ interface AnimationNode extends RBXObject {
823
823
  readonly _nominal_AnimationNode: unique symbol;
824
824
  }
825
825
  /**
826
- * A class which defines a piece of content, such as a screnshot or video, taken in-experience.
826
+ * A class which defines a piece of content, such as a screenshot or video, taken in-experience.
827
827
  *
828
828
  * - **Tags**: NotCreatable, NotReplicated
829
829
  *
@@ -10245,11 +10245,11 @@ interface Plugin extends Instance {
10245
10245
  *
10246
10246
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Activate)
10247
10247
  * @param this
10248
- * @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If true, a `PluginMouse` can be retrieved via `Plugin:GetMouse()`.
10248
+ * @param exclusiveMouse A boolean specifying whether to activate the plugin with exclusive mouse. If `true`, a `PluginMouse` can be retrieved via `GetMouse()`.
10249
10249
  */
10250
10250
  Activate(this: Plugin, exclusiveMouse: boolean): void;
10251
10251
  /**
10252
- * Creates a `PluginAction` which is an object that represents a generic performable action in Roblox Studio, with no directly associated `Toolbar` or `Button`.
10252
+ * Creates a `PluginAction` which represents a generic performable action in Studio with no directlyassociated `PluginToolbarButton`.
10253
10253
  *
10254
10254
  * - **ThreadSafety**: Unsafe
10255
10255
  *
@@ -10270,8 +10270,8 @@ interface Plugin extends Instance {
10270
10270
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginMenu)
10271
10271
  * @param this
10272
10272
  * @param id Unique ID for the menu.
10273
- * @param title The text to be displayed when used as a sub menu.
10274
- * @param icon The icon to be displayed when used as a sub menu.
10273
+ * @param title The text to be displayed when used as a submenu.
10274
+ * @param icon The icon to be displayed when used as a submenu.
10275
10275
  */
10276
10276
  CreatePluginMenu(this: Plugin, id: string, title?: string, icon?: string): PluginMenu;
10277
10277
  /**
@@ -10294,7 +10294,7 @@ interface Plugin extends Instance {
10294
10294
  */
10295
10295
  Deactivate(this: Plugin): void;
10296
10296
  /**
10297
- * Returns the `JointCreationMode` the user has set in Studio under the Model tab.
10297
+ * Returns the `JointCreationMode` the user has set in Studio's toolbar.
10298
10298
  *
10299
10299
  * - **ThreadSafety**: Unsafe
10300
10300
  *
@@ -10345,6 +10345,8 @@ interface Plugin extends Instance {
10345
10345
  */
10346
10346
  GetStudioUserId(this: Plugin): number;
10347
10347
  /**
10348
+ * Intersects the given parts and returns the resulting `IntersectOperation`.
10349
+ *
10348
10350
  * - **ThreadSafety**: Unsafe
10349
10351
  *
10350
10352
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plugin#Intersect)
@@ -10353,7 +10355,7 @@ interface Plugin extends Instance {
10353
10355
  */
10354
10356
  Intersect(this: Plugin, objects: Array<Instance>): Instance | undefined;
10355
10357
  /**
10356
- * Returns true if this plugin is currently active, after having been activated via the `Plugin:Activate()` function.
10358
+ * Returns `true` if this plugin is currently active, after having been activated via the `Activate()` function.
10357
10359
  *
10358
10360
  * - **ThreadSafety**: Unsafe
10359
10361
  *
@@ -10363,7 +10365,7 @@ interface Plugin extends Instance {
10363
10365
  */
10364
10366
  IsActivated(this: Plugin): boolean;
10365
10367
  /**
10366
- * Returns true if this plugin is currently active with an exclusive mouse, after having been activated via the `Plugin:Activate()` function.
10368
+ * Returns `true` if this plugin is currently active with an exclusive mouse.
10367
10369
  *
10368
10370
  * - **ThreadSafety**: Unsafe
10369
10371
  *
@@ -10373,7 +10375,7 @@ interface Plugin extends Instance {
10373
10375
  */
10374
10376
  IsActivatedWithExclusiveMouse(this: Plugin): boolean;
10375
10377
  /**
10376
- * Negates the given parts and returns the resulting NegateOperations.
10378
+ * Negates the given parts and returns the resulting `NegateOperations`.
10377
10379
  *
10378
10380
  * - **ThreadSafety**: Unsafe
10379
10381
  *
@@ -10429,7 +10431,7 @@ interface Plugin extends Instance {
10429
10431
  */
10430
10432
  SelectRibbonTool(this: Plugin, tool: CastsToEnum<Enum.RibbonTool>, position: UDim2): void;
10431
10433
  /**
10432
- * Separates the given UnionOperations and returns the resulting parts.
10434
+ * Separates the given `UnionOperations` and returns the resulting parts.
10433
10435
  *
10434
10436
  * - **ThreadSafety**: Unsafe
10435
10437
  *
@@ -10460,7 +10462,7 @@ interface Plugin extends Instance {
10460
10462
  */
10461
10463
  StartDrag(this: Plugin, dragData: object): void;
10462
10464
  /**
10463
- * Unions the given parts and returns the resulting UnionOperation.
10465
+ * Unions the given parts and returns the resulting `UnionOperation`.
10464
10466
  *
10465
10467
  * - **ThreadSafety**: Unsafe
10466
10468
  *
@@ -10470,7 +10472,7 @@ interface Plugin extends Instance {
10470
10472
  */
10471
10473
  Union(this: Plugin, objects: Array<BasePart>): UnionOperation;
10472
10474
  /**
10473
- * **Deprecated:**
10475
+ * **Deprecated:** This method has been superseded by `CreateDockWidgetPluginGuiAsync()`.
10474
10476
  *
10475
10477
  * Creates a `DockWidgetPluginGui` given a `DockWidgetPluginGuiInfo`.
10476
10478
  *
@@ -10500,7 +10502,7 @@ interface Plugin extends Instance {
10500
10502
  /**
10501
10503
  * **Deprecated:**
10502
10504
  *
10503
- * Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
10505
+ * Prompts the user to open a `.fbx` animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
10504
10506
  *
10505
10507
  * - **ThreadSafety**: Unsafe
10506
10508
  * - **Tags**: Yields
@@ -10514,7 +10516,7 @@ interface Plugin extends Instance {
10514
10516
  */
10515
10517
  ImportFbxAnimation(this: Plugin, rigModel: Instance, isR15?: boolean): Instance | undefined;
10516
10518
  /**
10517
- * Prompts the user to open a .fbx animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
10519
+ * Prompts the user to open a `.fbx` animation file that can be loaded onto the `rigModel`, then proceeds to insert the animation as a `KeyframeSequence` in the `Workspace`.
10518
10520
  *
10519
10521
  * - **ThreadSafety**: Unsafe
10520
10522
  * - **Tags**: Yields
@@ -10528,7 +10530,7 @@ interface Plugin extends Instance {
10528
10530
  /**
10529
10531
  * **Deprecated:**
10530
10532
  *
10531
- * Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
10533
+ * Prompts the user to open a `.fbx` file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
10532
10534
  *
10533
10535
  * - **ThreadSafety**: Unsafe
10534
10536
  * - **Tags**: Yields
@@ -10541,7 +10543,7 @@ interface Plugin extends Instance {
10541
10543
  */
10542
10544
  ImportFbxRig(this: Plugin, isR15?: boolean): Model;
10543
10545
  /**
10544
- * Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
10546
+ * Prompts the user to open a `.fbx` file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the `Workspace`.
10545
10547
  *
10546
10548
  * - **ThreadSafety**: Unsafe
10547
10549
  * - **Tags**: Yields
@@ -10552,7 +10554,7 @@ interface Plugin extends Instance {
10552
10554
  */
10553
10555
  ImportFbxRigAsync(this: Plugin, isR15?: boolean): Instance | undefined;
10554
10556
  /**
10555
- * Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
10557
+ * Opens a window in Roblox Studio which prompts the user to select an asset based on the `assetType` specified.
10556
10558
  *
10557
10559
  * - **ThreadSafety**: Unsafe
10558
10560
  * - **Tags**: Yields
@@ -10563,7 +10565,7 @@ interface Plugin extends Instance {
10563
10565
  */
10564
10566
  PromptForExistingAssetId(this: Plugin, assetType: string): number;
10565
10567
  /**
10566
- * Opens a window in Roblox Studio, which prompts the user to select an asset based on the `assetType` specified. Returns what assetId was selected, or -1 if the window was closed.
10568
+ * Opens a window in Roblox Studio which prompts the user to select an asset based on the `assetType` specified.
10567
10569
  *
10568
10570
  * - **ThreadSafety**: Unsafe
10569
10571
  * - **Tags**: Yields
@@ -10576,7 +10578,7 @@ interface Plugin extends Instance {
10576
10578
  /**
10577
10579
  * **Deprecated:**
10578
10580
  *
10579
- * Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
10581
+ * Prompts the user to save their current selection with the specified file name.
10580
10582
  *
10581
10583
  * - **ThreadSafety**: Unsafe
10582
10584
  * - **Tags**: Yields
@@ -10589,7 +10591,7 @@ interface Plugin extends Instance {
10589
10591
  */
10590
10592
  PromptSaveSelection(this: Plugin, suggestedFileName?: string): boolean;
10591
10593
  /**
10592
- * Prompts the user to save their current selection with the specified file name. Returns true if the user did save the file.
10594
+ * Prompts the user to save their current selection with the specified file name.
10593
10595
  *
10594
10596
  * - **ThreadSafety**: Unsafe
10595
10597
  * - **Tags**: Yields
@@ -10631,7 +10633,7 @@ interface PluginAction extends Instance {
10631
10633
  */
10632
10634
  readonly _nominal_PluginAction: unique symbol;
10633
10635
  /**
10634
- * Fires when the action is triggered. This can be done by either activating the action from the Quick Access Toolbar, or by using the keyboard shortcut that was bound to it.
10636
+ * Fires when the action is triggered.
10635
10637
  *
10636
10638
  * - **ThreadSafety**: Unsafe
10637
10639
  *
@@ -10790,7 +10792,7 @@ interface PluginMenu extends Instance {
10790
10792
  *
10791
10793
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddMenu)
10792
10794
  * @param this A context menu that can be shown in Studio. Displays a list of `PluginActions` and supports submenus.
10793
- * @param menu The menu to add as a sub menu. Uses its `PluginMenu.Title` and `PluginMenu.Icon` to display.
10795
+ * @param menu The menu to add as a submenu. Uses its `Title` and `Icon` to display.
10794
10796
  */
10795
10797
  AddMenu(this: PluginMenu, menu: PluginMenu): void;
10796
10798
  /**
@@ -10800,7 +10802,7 @@ interface PluginMenu extends Instance {
10800
10802
  *
10801
10803
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddNewAction)
10802
10804
  * @param this A context menu that can be shown in Studio. Displays a list of `PluginActions` and supports submenus.
10803
- * @param actionId Must be a unique string that identifies this PluginAction from others.
10805
+ * @param actionId Must be a unique string that identifies this `PluginAction` from others.
10804
10806
  * @param text The text to be displayed.
10805
10807
  * @param icon The icon to be displayed.
10806
10808
  * @returns The created `PluginAction`.
@@ -10874,8 +10876,8 @@ interface PluginToolbar extends Instance {
10874
10876
  * @param this
10875
10877
  * @param buttonId A unique button ID.
10876
10878
  * @param tooltip The text displayed in the tooltip shown when a user hovers over the button.
10877
- * @param iconname The asset ID (e.g. rbxassetid://1507949215) of the icon displayed in the button.
10878
- * @param text Text displayed under the button icon. Optional. If this field is not provided, the **ID** will be used instead.
10879
+ * @param iconname The asset ID of the icon displayed in the button.
10880
+ * @param text Optional text displayed under the button icon.
10879
10881
  * @returns The created `PluginToolbarButton` instance.
10880
10882
  */
10881
10883
  CreateButton(this: PluginToolbar, buttonId: string, tooltip: string, iconname: string, text?: string): PluginToolbarButton;
@@ -14168,7 +14170,7 @@ interface TestService extends Instance {
14168
14170
  /**
14169
14171
  * **Deprecated:**
14170
14172
  *
14171
- * Runs scripts which are parented to TestService.
14173
+ * Runs scripts which are parented to `TestService`.
14172
14174
  *
14173
14175
  * - **ThreadSafety**: Unsafe
14174
14176
  * - **Tags**: Yields
@@ -14180,7 +14182,7 @@ interface TestService extends Instance {
14180
14182
  */
14181
14183
  Run(this: TestService): void;
14182
14184
  /**
14183
- * Runs scripts which are parented to TestService.
14185
+ * Runs scripts which are parented to `TestService`.
14184
14186
  *
14185
14187
  * - **ThreadSafety**: Unsafe
14186
14188
  * - **Tags**: Yields
@@ -13020,7 +13020,7 @@ declare namespace Enum {
13020
13020
  }
13021
13021
  export const Legacy: Legacy;
13022
13022
  /**
13023
- * Arial has been removed from Roblox. Using Arial will map to Arimo.
13023
+ * `Arial` has been removed. Using it will map to the `Arimo` font family of the `Font` data type.
13024
13024
  *
13025
13025
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Arial)
13026
13026
  */
@@ -13031,7 +13031,7 @@ declare namespace Enum {
13031
13031
  }
13032
13032
  export const Arial: Arial;
13033
13033
  /**
13034
- * Arial has been removed from Roblox. Using Arial will map to Arimo.
13034
+ * `ArialBold` has been removed. Using it will map to the `Arimo` font family of the `Font` data type.
13035
13035
  *
13036
13036
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#ArialBold)
13037
13037
  */
@@ -13196,7 +13196,7 @@ declare namespace Enum {
13196
13196
  }
13197
13197
  export const SourceSansSemibold: SourceSansSemibold;
13198
13198
  /**
13199
- * Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
13199
+ * `Gotham` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
13200
13200
  *
13201
13201
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Gotham)
13202
13202
  */
@@ -13211,7 +13211,7 @@ declare namespace Enum {
13211
13211
  */
13212
13212
  export const Montserrat: Gotham;
13213
13213
  /**
13214
- * Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
13214
+ * `GothamMedium` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
13215
13215
  *
13216
13216
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamMedium)
13217
13217
  */
@@ -13230,7 +13230,7 @@ declare namespace Enum {
13230
13230
  */
13231
13231
  export const MontserratMedium: GothamMedium;
13232
13232
  /**
13233
- * Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
13233
+ * `GothamBold` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
13234
13234
  *
13235
13235
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamBold)
13236
13236
  */
@@ -13245,7 +13245,7 @@ declare namespace Enum {
13245
13245
  */
13246
13246
  export const MontserratBold: GothamBold;
13247
13247
  /**
13248
- * Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
13248
+ * `GothamBlack` has been removed. Using it will map to the `Montserrat` font family of the `Font` data type.
13249
13249
  *
13250
13250
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#GothamBlack)
13251
13251
  */
@@ -13601,7 +13601,7 @@ declare namespace Enum {
13601
13601
  }
13602
13602
  export const ArimoBold: ArimoBold;
13603
13603
  /**
13604
- * Set when the `TextLabel.FontFace` property is set to a `Font` that has no corresponding enum value.
13604
+ * Set when the GUI object's font face is set to a `Font` that has no corresponding enum value.
13605
13605
  *
13606
13606
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Font#Unknown)
13607
13607
  */
@@ -13621,7 +13621,7 @@ declare namespace Enum {
13621
13621
  */
13622
13622
  export namespace FontSize {
13623
13623
  /**
13624
- * Font size 8.
13624
+ * Font size `8`.
13625
13625
  *
13626
13626
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size8)
13627
13627
  */
@@ -13632,7 +13632,7 @@ declare namespace Enum {
13632
13632
  }
13633
13633
  export const Size8: Size8;
13634
13634
  /**
13635
- * Font size 9.
13635
+ * Font size `9`.
13636
13636
  *
13637
13637
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size9)
13638
13638
  */
@@ -13643,7 +13643,7 @@ declare namespace Enum {
13643
13643
  }
13644
13644
  export const Size9: Size9;
13645
13645
  /**
13646
- * Font size 10.
13646
+ * Font size `10`.
13647
13647
  *
13648
13648
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size10)
13649
13649
  */
@@ -13654,7 +13654,7 @@ declare namespace Enum {
13654
13654
  }
13655
13655
  export const Size10: Size10;
13656
13656
  /**
13657
- * Font size 11.
13657
+ * Font size `11`.
13658
13658
  *
13659
13659
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size11)
13660
13660
  */
@@ -13665,7 +13665,7 @@ declare namespace Enum {
13665
13665
  }
13666
13666
  export const Size11: Size11;
13667
13667
  /**
13668
- * Font size 12.
13668
+ * Font size `12`.
13669
13669
  *
13670
13670
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size12)
13671
13671
  */
@@ -13676,7 +13676,7 @@ declare namespace Enum {
13676
13676
  }
13677
13677
  export const Size12: Size12;
13678
13678
  /**
13679
- * Font size 14.
13679
+ * Font size `14`.
13680
13680
  *
13681
13681
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size14)
13682
13682
  */
@@ -13687,7 +13687,7 @@ declare namespace Enum {
13687
13687
  }
13688
13688
  export const Size14: Size14;
13689
13689
  /**
13690
- * Font size 18.
13690
+ * Font size `18`.
13691
13691
  *
13692
13692
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size18)
13693
13693
  */
@@ -13698,7 +13698,7 @@ declare namespace Enum {
13698
13698
  }
13699
13699
  export const Size18: Size18;
13700
13700
  /**
13701
- * Font size 24.
13701
+ * Font size `24`.
13702
13702
  *
13703
13703
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size24)
13704
13704
  */
@@ -13709,7 +13709,7 @@ declare namespace Enum {
13709
13709
  }
13710
13710
  export const Size24: Size24;
13711
13711
  /**
13712
- * Font size 36.
13712
+ * Font size `36`.
13713
13713
  *
13714
13714
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size36)
13715
13715
  */
@@ -13720,7 +13720,7 @@ declare namespace Enum {
13720
13720
  }
13721
13721
  export const Size36: Size36;
13722
13722
  /**
13723
- * Font size 48.
13723
+ * Font size `48`.
13724
13724
  *
13725
13725
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size48)
13726
13726
  */
@@ -13731,7 +13731,7 @@ declare namespace Enum {
13731
13731
  }
13732
13732
  export const Size48: Size48;
13733
13733
  /**
13734
- * Font size 28.
13734
+ * Font size `28`.
13735
13735
  *
13736
13736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size28)
13737
13737
  */
@@ -13742,7 +13742,7 @@ declare namespace Enum {
13742
13742
  }
13743
13743
  export const Size28: Size28;
13744
13744
  /**
13745
- * Font size 32.
13745
+ * Font size `32`.
13746
13746
  *
13747
13747
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size32)
13748
13748
  */
@@ -13753,7 +13753,7 @@ declare namespace Enum {
13753
13753
  }
13754
13754
  export const Size32: Size32;
13755
13755
  /**
13756
- * Font size 42.
13756
+ * Font size `42`.
13757
13757
  *
13758
13758
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size42)
13759
13759
  */
@@ -13764,7 +13764,7 @@ declare namespace Enum {
13764
13764
  }
13765
13765
  export const Size42: Size42;
13766
13766
  /**
13767
- * Font size 60.
13767
+ * Font size `60`.
13768
13768
  *
13769
13769
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size60)
13770
13770
  */
@@ -13775,7 +13775,7 @@ declare namespace Enum {
13775
13775
  }
13776
13776
  export const Size60: Size60;
13777
13777
  /**
13778
- * Font size 96.
13778
+ * Font size `96`.
13779
13779
  *
13780
13780
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontSize#Size96)
13781
13781
  */
@@ -13791,7 +13791,7 @@ declare namespace Enum {
13791
13791
  }
13792
13792
  export type FontSize = FontSize.Size8 | FontSize.Size9 | FontSize.Size10 | FontSize.Size11 | FontSize.Size12 | FontSize.Size14 | FontSize.Size18 | FontSize.Size24 | FontSize.Size36 | FontSize.Size48 | FontSize.Size28 | FontSize.Size32 | FontSize.Size42 | FontSize.Size60 | FontSize.Size96;
13793
13793
  /**
13794
- * Describes whether a `Font` is italic or not.
13794
+ * Describes whether a `Font` style is normal or italic.
13795
13795
  *
13796
13796
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FontStyle)
13797
13797
  */
@@ -15630,11 +15630,29 @@ declare namespace Enum {
15630
15630
  EnumType: typeof globalThis.Enum.HttpError;
15631
15631
  }
15632
15632
  export const CreatorEnvironmentsNotSupportedByService: CreatorEnvironmentsNotSupportedByService;
15633
+ /**
15634
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpError#InactivityTimeout)
15635
+ */
15636
+ export interface InactivityTimeout extends globalThis.EnumItem {
15637
+ Name: "InactivityTimeout";
15638
+ Value: 16;
15639
+ EnumType: typeof globalThis.Enum.HttpError;
15640
+ }
15641
+ export const InactivityTimeout: InactivityTimeout;
15642
+ /**
15643
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpError#TooManyOutstandingRequests)
15644
+ */
15645
+ export interface TooManyOutstandingRequests extends globalThis.EnumItem {
15646
+ Name: "TooManyOutstandingRequests";
15647
+ Value: 17;
15648
+ EnumType: typeof globalThis.Enum.HttpError;
15649
+ }
15650
+ export const TooManyOutstandingRequests: TooManyOutstandingRequests;
15633
15651
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.HttpError>;
15634
15652
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.HttpError | undefined;
15635
15653
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.HttpError | undefined;
15636
15654
  }
15637
- export type HttpError = HttpError.OK | HttpError.InvalidUrl | HttpError.DnsResolve | HttpError.ConnectFail | HttpError.OutOfMemory | HttpError.TimedOut | HttpError.TooManyRedirects | HttpError.InvalidRedirect | HttpError.NetFail | HttpError.Aborted | HttpError.SslConnectFail | HttpError.SslVerificationFail | HttpError.Unknown | HttpError.ConnectionClosed | HttpError.ServerProtocolError | HttpError.CreatorEnvironmentsNotSupportedByService;
15655
+ export type HttpError = HttpError.OK | HttpError.InvalidUrl | HttpError.DnsResolve | HttpError.ConnectFail | HttpError.OutOfMemory | HttpError.TimedOut | HttpError.TooManyRedirects | HttpError.InvalidRedirect | HttpError.NetFail | HttpError.Aborted | HttpError.SslConnectFail | HttpError.SslVerificationFail | HttpError.Unknown | HttpError.ConnectionClosed | HttpError.ServerProtocolError | HttpError.CreatorEnvironmentsNotSupportedByService | HttpError.InactivityTimeout | HttpError.TooManyOutstandingRequests;
15638
15656
  /**
15639
15657
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/HttpRequestType)
15640
15658
  */
@@ -26345,7 +26363,7 @@ declare namespace Enum {
26345
26363
  }
26346
26364
  export const Comment: Comment;
26347
26365
  /**
26348
- * The user joined an experience through the item.
26366
+ * The user joined an experience through the item, or played a mini-game associated with the item.
26349
26367
  *
26350
26368
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Play)
26351
26369
  */
@@ -28583,7 +28601,7 @@ declare namespace Enum {
28583
28601
  }
28584
28602
  export const CoreUISafeInsets: CoreUISafeInsets;
28585
28603
  /**
28586
- * Top bar safe area insets are added to the `DeviceSafeInsets` area, resulting in an area guaranteed to be unobscured by both device screen cutouts and Roblox core UI elements like the experience controls. Unlike `CoreUISafeInsets`, this area's position and size is dynamic and is limited to the space available within the top bar area itself, outside of `CoreUISafeInsets`.
28604
+ * Top bar safe area insets are added to the `DeviceSafeInsets` area, resulting in an area guaranteed to be unobscured by both device screen cutouts and Roblox core UI elements like the experience controls. Unlike `CoreUISafeInsets`, this area's position and size is dynamic and is limited to the space available within the top bar area itself, outside of `CoreUISafeInsets`. See the `GuiService.TopbarInset` property which represents the absolute size and position of the unobstructed area within the top bar space.
28587
28605
  *
28588
28606
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenInsets#TopbarSafeInsets)
28589
28607
  */
@@ -28664,6 +28682,51 @@ declare namespace Enum {
28664
28682
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ScreenOrientation | undefined;
28665
28683
  }
28666
28684
  export type ScreenOrientation = ScreenOrientation.LandscapeLeft | ScreenOrientation.LandscapeRight | ScreenOrientation.LandscapeSensor | ScreenOrientation.Portrait | ScreenOrientation.Sensor;
28685
+ /**
28686
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenshotCaptureResult)
28687
+ */
28688
+ export namespace ScreenshotCaptureResult {
28689
+ /**
28690
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenshotCaptureResult#Success)
28691
+ */
28692
+ export interface Success extends globalThis.EnumItem {
28693
+ Name: "Success";
28694
+ Value: 0;
28695
+ EnumType: typeof globalThis.Enum.ScreenshotCaptureResult;
28696
+ }
28697
+ export const Success: Success;
28698
+ /**
28699
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenshotCaptureResult#OtherError)
28700
+ */
28701
+ export interface OtherError extends globalThis.EnumItem {
28702
+ Name: "OtherError";
28703
+ Value: 1;
28704
+ EnumType: typeof globalThis.Enum.ScreenshotCaptureResult;
28705
+ }
28706
+ export const OtherError: OtherError;
28707
+ /**
28708
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenshotCaptureResult#NoDeviceSupport)
28709
+ */
28710
+ export interface NoDeviceSupport extends globalThis.EnumItem {
28711
+ Name: "NoDeviceSupport";
28712
+ Value: 2;
28713
+ EnumType: typeof globalThis.Enum.ScreenshotCaptureResult;
28714
+ }
28715
+ export const NoDeviceSupport: NoDeviceSupport;
28716
+ /**
28717
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScreenshotCaptureResult#NoSpaceOnDevice)
28718
+ */
28719
+ export interface NoSpaceOnDevice extends globalThis.EnumItem {
28720
+ Name: "NoSpaceOnDevice";
28721
+ Value: 3;
28722
+ EnumType: typeof globalThis.Enum.ScreenshotCaptureResult;
28723
+ }
28724
+ export const NoSpaceOnDevice: NoSpaceOnDevice;
28725
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ScreenshotCaptureResult>;
28726
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ScreenshotCaptureResult | undefined;
28727
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ScreenshotCaptureResult | undefined;
28728
+ }
28729
+ export type ScreenshotCaptureResult = ScreenshotCaptureResult.Success | ScreenshotCaptureResult.OtherError | ScreenshotCaptureResult.NoDeviceSupport | ScreenshotCaptureResult.NoSpaceOnDevice;
28667
28730
  /**
28668
28731
  * This enum is used with `ScrollingFrame.HorizontalScrollBarInset` and `ScrollingFrame.VerticalScrollBarInset` to indicate whether the canvas should be inset by `ScrollBarThickness` for the respective scroll bar.
28669
28732
  *
@@ -34976,10 +35039,14 @@ declare namespace Enum {
34976
35039
  }
34977
35040
  export type TweenStatus = TweenStatus.Canceled | TweenStatus.Completed;
34978
35041
  /**
35042
+ * Used to determine what UI elements should be captured with `CaptureService`.
35043
+ *
34979
35044
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode)
34980
35045
  */
34981
35046
  export namespace UICaptureMode {
34982
35047
  /**
35048
+ * Capture all UI elements.
35049
+ *
34983
35050
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#All)
34984
35051
  */
34985
35052
  export interface All extends globalThis.EnumItem {
@@ -34989,6 +35056,8 @@ declare namespace Enum {
34989
35056
  }
34990
35057
  export const All: All;
34991
35058
  /**
35059
+ * Capture no UI elements.
35060
+ *
34992
35061
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#None)
34993
35062
  */
34994
35063
  export interface None extends globalThis.EnumItem {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.901",
3
+ "version": "1.0.902",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },