@rbxts/types 1.0.901 → 1.0.903

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.
@@ -49,6 +49,7 @@ interface Services {
49
49
  ContextActionService: ContextActionService;
50
50
  ControllerService: ControllerService;
51
51
  ConversationalAIAcceptanceService: ConversationalAIAcceptanceService;
52
+ CoreGuiConfiguration: CoreGuiConfiguration;
52
53
  CoreScriptDebuggingManagerHelper: CoreScriptDebuggingManagerHelper;
53
54
  CreationDBService: CreationDBService;
54
55
  CreatorStoreService: CreatorStoreService;
@@ -563,6 +564,7 @@ interface Instances extends Services, CreatableInstances {
563
564
  AuroraScriptObject: AuroraScriptObject;
564
565
  BackpackItem: BackpackItem;
565
566
  BanHistoryPages: BanHistoryPages;
567
+ BaseCoreGuiConfiguration: BaseCoreGuiConfiguration;
566
568
  BaseImportData: BaseImportData;
567
569
  BasePart: BasePart;
568
570
  BasePlayerGui: BasePlayerGui;
@@ -573,6 +575,7 @@ interface Instances extends Services, CreatableInstances {
573
575
  BodyMover: BodyMover;
574
576
  BubbleChatConfiguration: BubbleChatConfiguration;
575
577
  CapturesPages: CapturesPages;
578
+ CapturesViewConfiguration: CapturesViewConfiguration;
576
579
  CatalogPages: CatalogPages;
577
580
  ChannelSelectorSoundEffect: ChannelSelectorSoundEffect;
578
581
  ChannelTabsConfiguration: ChannelTabsConfiguration;
@@ -665,6 +668,7 @@ interface Instances extends Services, CreatableInstances {
665
668
  PlayerDataRecord: PlayerDataRecord;
666
669
  PlayerDataRecordConfig: PlayerDataRecordConfig;
667
670
  PlayerGui: PlayerGui;
671
+ PlayerListConfiguration: PlayerListConfiguration;
668
672
  PlayerMouse: PlayerMouse;
669
673
  PlayerScripts: PlayerScripts;
670
674
  PluginManagerInterface: PluginManagerInterface;
@@ -679,6 +683,7 @@ interface Instances extends Services, CreatableInstances {
679
683
  ScriptBuilder: ScriptBuilder;
680
684
  ScriptRuntime: ScriptRuntime;
681
685
  SelectionLasso: SelectionLasso;
686
+ SelfViewConfiguration: SelfViewConfiguration;
682
687
  SensorBase: SensorBase;
683
688
  ServiceProvider: ServiceProvider;
684
689
  SlidingBallConstraint: SlidingBallConstraint;
@@ -811,7 +816,7 @@ interface AnimationNode extends RBXObject {
811
816
  readonly _nominal_AnimationNode: unique symbol;
812
817
  }
813
818
  /**
814
- * A class which defines a piece of content, such as a screnshot or video, taken in-experience.
819
+ * A class which defines a piece of content, such as a screenshot or video, taken in-experience.
815
820
  *
816
821
  * - **Tags**: NotCreatable, NotReplicated
817
822
  *
@@ -2930,13 +2935,15 @@ interface AdService extends Instance {
2930
2935
  */
2931
2936
  GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): unknown;
2932
2937
  /**
2938
+ * Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad.
2939
+ *
2933
2940
  * - **ThreadSafety**: Unsafe
2934
2941
  * - **Tags**: Yields
2935
2942
  *
2936
2943
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
2937
2944
  * @param this A class that allows the display of mobile video ads.
2938
2945
  * @param instance
2939
- * @param placementId
2946
+ * @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
2947
  */
2941
2948
  RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
2942
2949
  /**
@@ -6820,7 +6827,7 @@ interface AudioReverb extends Instance {
6820
6827
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
6821
6828
  }
6822
6829
  /**
6823
- * Instance to be passed to `AssetService:SearchAudio()` to search for audio assets.
6830
+ * Instance to be passed to `AssetService:SearchAudioAsync()` to search for audio assets.
6824
6831
  *
6825
6832
  * - **Tags**: NotReplicated
6826
6833
  *
@@ -7430,12 +7437,6 @@ interface AuroraService extends Instance {
7430
7437
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetIncomingReplicationLag)
7431
7438
  */
7432
7439
  SetIncomingReplicationLag(this: AuroraService, seconds: number): void;
7433
- /**
7434
- * - **ThreadSafety**: Unsafe
7435
- *
7436
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetPropertyIsInput)
7437
- */
7438
- SetPropertyIsInput(this: AuroraService, target: Instance, propertyName: string, isInput: boolean): void;
7439
7440
  /**
7440
7441
  * - **ThreadSafety**: Unsafe
7441
7442
  *
@@ -7623,14 +7624,7 @@ interface AvatarCreationService extends Instance {
7623
7624
  * @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
7625
  * @returns A unique identifier for the generated avatar.
7625
7626
  */
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;
7627
+ AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
7634
7628
  /**
7635
7629
  * Creates a 2D avatar preview and returns a previewId.
7636
7630
  *
@@ -8063,6 +8057,13 @@ interface AvatarEditorService extends Instance {
8063
8057
  * @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
8064
8058
  */
8065
8059
  GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
8060
+ /**
8061
+ * - **ThreadSafety**: Unsafe
8062
+ * - **Tags**: Yields
8063
+ *
8064
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
8065
+ */
8066
+ GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
8066
8067
  /**
8067
8068
  * **Deprecated:**
8068
8069
  *
@@ -8485,7 +8486,7 @@ interface BadgeService extends Instance {
8485
8486
  */
8486
8487
  IsLegal(this: BadgeService, badgeId: number): boolean;
8487
8488
  /**
8488
- * **Deprecated:** This function has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
8489
+ * **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
8489
8490
  *
8490
8491
  * Checks whether a user has the badge given the `Player.UserId` and the badge ID.
8491
8492
  *
@@ -8515,6 +8516,90 @@ interface BadgeService extends Instance {
8515
8516
  */
8516
8517
  UserHasBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
8517
8518
  }
8519
+ /**
8520
+ * - **Tags**: NotCreatable, NotReplicated
8521
+ *
8522
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration)
8523
+ */
8524
+ interface BaseCoreGuiConfiguration extends Instance {
8525
+ /**
8526
+ * **DO NOT USE!**
8527
+ *
8528
+ * This field exists to force TypeScript to recognize this as a nominal type
8529
+ * @hidden
8530
+ * @deprecated
8531
+ */
8532
+ readonly _nominal_BaseCoreGuiConfiguration: unique symbol;
8533
+ /**
8534
+ * - **ThreadSafety**: ReadSafe
8535
+ *
8536
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration#Enabled)
8537
+ */
8538
+ Enabled: boolean;
8539
+ }
8540
+ /**
8541
+ * - **Tags**: NotCreatable, NotReplicated
8542
+ *
8543
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration)
8544
+ */
8545
+ interface CapturesViewConfiguration extends BaseCoreGuiConfiguration {
8546
+ /**
8547
+ * **DO NOT USE!**
8548
+ *
8549
+ * This field exists to force TypeScript to recognize this as a nominal type
8550
+ * @hidden
8551
+ * @deprecated
8552
+ */
8553
+ readonly _nominal_CapturesViewConfiguration: unique symbol;
8554
+ /**
8555
+ * - **ThreadSafety**: ReadSafe
8556
+ *
8557
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration#Open)
8558
+ */
8559
+ Open: boolean;
8560
+ }
8561
+ /**
8562
+ * - **Tags**: NotCreatable, NotReplicated
8563
+ *
8564
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration)
8565
+ */
8566
+ interface PlayerListConfiguration extends BaseCoreGuiConfiguration {
8567
+ /**
8568
+ * **DO NOT USE!**
8569
+ *
8570
+ * This field exists to force TypeScript to recognize this as a nominal type
8571
+ * @hidden
8572
+ * @deprecated
8573
+ */
8574
+ readonly _nominal_PlayerListConfiguration: unique symbol;
8575
+ /**
8576
+ * - **ThreadSafety**: ReadSafe
8577
+ *
8578
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration#Open)
8579
+ */
8580
+ Open: boolean;
8581
+ }
8582
+ /**
8583
+ * - **Tags**: NotCreatable, NotReplicated
8584
+ *
8585
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration)
8586
+ */
8587
+ interface SelfViewConfiguration extends BaseCoreGuiConfiguration {
8588
+ /**
8589
+ * **DO NOT USE!**
8590
+ *
8591
+ * This field exists to force TypeScript to recognize this as a nominal type
8592
+ * @hidden
8593
+ * @deprecated
8594
+ */
8595
+ readonly _nominal_SelfViewConfiguration: unique symbol;
8596
+ /**
8597
+ * - **ThreadSafety**: ReadSafe
8598
+ *
8599
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration#Open)
8600
+ */
8601
+ Open: boolean;
8602
+ }
8518
8603
  /**
8519
8604
  * - **Tags**: NotCreatable, NotReplicated
8520
8605
  *
@@ -10493,12 +10578,9 @@ interface CaptureService extends Instance {
10493
10578
  /**
10494
10579
  * - **ThreadSafety**: Unsafe
10495
10580
  *
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
10581
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeScreenshotCaptureAsync)
10500
10582
  */
10501
- TakeCapture(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
10583
+ TakeScreenshotCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
10502
10584
  /**
10503
10585
  * - **ThreadSafety**: Unsafe
10504
10586
  * - **Tags**: Yields
@@ -14553,6 +14635,39 @@ interface ConversationalAIAcceptanceService extends Instance {
14553
14635
  */
14554
14636
  readonly _nominal_ConversationalAIAcceptanceService: unique symbol;
14555
14637
  }
14638
+ /**
14639
+ * - **Tags**: NotCreatable, Service, NotReplicated
14640
+ *
14641
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration)
14642
+ */
14643
+ interface CoreGuiConfiguration extends Instance {
14644
+ /**
14645
+ * **DO NOT USE!**
14646
+ *
14647
+ * This field exists to force TypeScript to recognize this as a nominal type
14648
+ * @hidden
14649
+ * @deprecated
14650
+ */
14651
+ readonly _nominal_CoreGuiConfiguration: unique symbol;
14652
+ /**
14653
+ * - **ThreadSafety**: ReadSafe
14654
+ *
14655
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#CapturesViewConfiguration)
14656
+ */
14657
+ CapturesViewConfiguration: CapturesViewConfiguration | undefined;
14658
+ /**
14659
+ * - **ThreadSafety**: ReadSafe
14660
+ *
14661
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#PlayerListConfiguration)
14662
+ */
14663
+ PlayerListConfiguration: PlayerListConfiguration | undefined;
14664
+ /**
14665
+ * - **ThreadSafety**: ReadSafe
14666
+ *
14667
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CoreGuiConfiguration#SelfViewConfiguration)
14668
+ */
14669
+ SelfViewConfiguration: SelfViewConfiguration | undefined;
14670
+ }
14556
14671
  /**
14557
14672
  * - **Tags**: NotCreatable, Service
14558
14673
  *
@@ -22192,7 +22307,7 @@ interface HapticEffect extends Instance {
22192
22307
  */
22193
22308
  Play(this: HapticEffect): void;
22194
22309
  /**
22195
- * Method used to define a custom waveform as a table and apply it to the haptic.
22310
+ * Defines a custom waveform as a table and applies it to the haptic. <pre><code>This method takes in an array of `FloatCurveKey` objects. </code></pre>
22196
22311
  *
22197
22312
  * - **ThreadSafety**: Unsafe
22198
22313
  *
@@ -24984,7 +25099,7 @@ interface InputAction extends Instance {
24984
25099
  /**
24985
25100
  * Returns the current state of the `InputAction`.
24986
25101
  *
24987
- * - **ThreadSafety**: Unsafe
25102
+ * - **ThreadSafety**: Safe
24988
25103
  *
24989
25104
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#GetState)
24990
25105
  * @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
@@ -25541,6 +25656,8 @@ interface InstanceExtensionsService extends Instance {
25541
25656
  readonly _nominal_InstanceExtensionsService: unique symbol;
25542
25657
  }
25543
25658
  /**
25659
+ * A service for interacting with file sync from a plugin.
25660
+ *
25544
25661
  * - **Tags**: NotCreatable, Service, NotReplicated
25545
25662
  *
25546
25663
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService)
@@ -27885,7 +28002,7 @@ interface MarketplaceService extends Instance {
27885
28002
  * local ProductIdentifier = { InfoType = Enum.InfoType.GamePass, Id = 123456 }
27886
28003
  * ```
27887
28004
  * @returns The array of ranked items in a personalized order for the current user. Each array has: - `ProductIdentifier`: The corresponding ID from the input array.
27888
- * - `ProductInfo`: The standard product info dictionary returned by `GetProductInfo`.
28005
+ * - `ProductInfo`: The standard product info dictionary returned by `GetProductInfoAsync`.
27889
28006
  */
27890
28007
  RankProductsAsync(this: MarketplaceService, productIdentifiers: Array<unknown>): Array<unknown>;
27891
28008
  /**
@@ -28126,6 +28243,8 @@ interface MaterialVariant extends Instance {
28126
28243
  */
28127
28244
  readonly _nominal_MaterialVariant: unique symbol;
28128
28245
  /**
28246
+ * Determines how the alpha channel of the `MaterialVariant.ColorMap` is used.
28247
+ *
28129
28248
  * - **ThreadSafety**: ReadSafe
28130
28249
  * - **Tags**: NotBrowsable
28131
28250
  *
@@ -32915,7 +33034,7 @@ interface Pages<T = unknown> extends Instance {
32915
33034
  AdvanceToNextPageAsync(this: Pages): void;
32916
33035
  }
32917
33036
  /**
32918
- * A special version of the `Pages` class returned by `AssetService:SearchAudio()`.
33037
+ * A special version of the `Pages` class returned by `AssetService:SearchAudioAsync()`.
32919
33038
  *
32920
33039
  * - **Tags**: NotCreatable, NotReplicated
32921
33040
  *
@@ -34826,7 +34945,7 @@ interface Player extends Instance {
34826
34945
  */
34827
34946
  GetRoleInGroupAsync(this: Player, groupId: number): string;
34828
34947
  /**
34829
- * **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
34948
+ * **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use `Player:IsFriendsWithAsync()` instead.
34830
34949
  *
34831
34950
  * Returns whether a player is connections with the specified user.
34832
34951
  *
@@ -34841,7 +34960,7 @@ interface Player extends Instance {
34841
34960
  */
34842
34961
  IsBestFriendsWith(this: Player, userId: number): boolean;
34843
34962
  /**
34844
- * **Deprecated:**
34963
+ * **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
34845
34964
  *
34846
34965
  * Checks whether a player is a connection of the user with the given `Player.UserId`.
34847
34966
  *
@@ -39155,7 +39274,7 @@ interface SocialService extends Instance {
39155
39274
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#OnCallInviteInvoked)
39156
39275
  * @param tag String to help differentiate between various phone book entry points.
39157
39276
  * @param callParticipantIds Array containing all of the players involved in the call. The caller will always be the first player in the array.
39158
- * @returns Table including the `PlaceId` and `ReservedServerAccessCode` keys whose values are the `DataModel.PlaceId` and the server access code returned by `TeleportService:ReserveServer()`, respectively.
39277
+ * @returns Table including the `PlaceId` and `ReservedServerAccessCode` keys whose values are the `DataModel.PlaceId` and the server access code returned by `TeleportService:ReserveServerAsync()`, respectively.
39159
39278
  */
39160
39279
  OnCallInviteInvoked: ((tag: string, callParticipantIds: Array<unknown>) => Instance) | undefined;
39161
39280
  }
@@ -41280,12 +41399,6 @@ interface StyleQuery extends Instance {
41280
41399
  * @deprecated
41281
41400
  */
41282
41401
  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
41402
  /**
41290
41403
  * - **ThreadSafety**: ReadSafe
41291
41404
  * - **Tags**: NotReplicated
@@ -41293,12 +41406,6 @@ interface StyleQuery extends Instance {
41293
41406
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
41294
41407
  */
41295
41408
  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
41409
  /**
41303
41410
  * - **ThreadSafety**: Unsafe
41304
41411
  *
@@ -41824,14 +41931,14 @@ interface TeleportService extends Instance {
41824
41931
  */
41825
41932
  TeleportToPlaceInstance(this: TeleportService, placeId: number, instanceId: string, player?: Player, spawnName?: string, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
41826
41933
  /**
41827
- * Teleport a group of `Players` to a reserved server created using `TeleportService:ReserveServer()`.
41934
+ * Teleport a group of `Players` to a reserved server created using `TeleportService:ReserveServerAsync()`.
41828
41935
  *
41829
41936
  * - **ThreadSafety**: Unsafe
41830
41937
  *
41831
41938
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPrivateServer)
41832
41939
  * @param this Enables transporting `Players` between places and servers.
41833
41940
  * @param placeId The ID of the place to teleport to.
41834
- * @param reservedServerAccessCode The reserved server access code returned by `TeleportService:ReserveServer()`.
41941
+ * @param reservedServerAccessCode The reserved server access code returned by `TeleportService:ReserveServerAsync()`.
41835
41942
  * @param players An array of `Players` to teleport.
41836
41943
  * @param spawnName Optional name of the `SpawnLocation` to spawn at.
41837
41944
  * @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
@@ -42096,7 +42203,7 @@ interface TestService extends Instance {
42096
42203
  */
42097
42204
  readonly _nominal_TestService: unique symbol;
42098
42205
  /**
42099
- * If set to true, the game will start running when the TestService's `TestService:Run()` method is called.
42206
+ * If set to `true`, the game will start running when the service's `TestService:RunAsync()` method is called.
42100
42207
  *
42101
42208
  * - **ThreadSafety**: ReadSafe
42102
42209
  *
@@ -42121,7 +42228,7 @@ interface TestService extends Instance {
42121
42228
  */
42122
42229
  readonly ErrorCount: number;
42123
42230
  /**
42124
- * When set to true, the TestService will be executed when using the *Run* action in Roblox Studio.
42231
+ * When set to `true`, `TestService` will be executed when using the **Run** action in Roblox Studio.
42125
42232
  *
42126
42233
  * - **ThreadSafety**: ReadSafe
42127
42234
  *
@@ -42208,7 +42315,7 @@ interface TestService extends Instance {
42208
42315
  */
42209
42316
  readonly WarnCount: number;
42210
42317
  /**
42211
- * Prints result of condition to output.
42318
+ * Prints result of a condition to the output.
42212
42319
  *
42213
42320
  * - **ThreadSafety**: Unsafe
42214
42321
  *
@@ -42221,7 +42328,7 @@ interface TestService extends Instance {
42221
42328
  */
42222
42329
  Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
42223
42330
  /**
42224
- * Prints "Test checkpoint: ", followed by text, to the output, in blue text.
42331
+ * Prints `Test checkpoint:` followed by a string to the output in blue text.
42225
42332
  *
42226
42333
  * - **ThreadSafety**: Unsafe
42227
42334
  *
@@ -42233,7 +42340,7 @@ interface TestService extends Instance {
42233
42340
  */
42234
42341
  Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
42235
42342
  /**
42236
- * Prints Testing Done to the output, in blue text.
42343
+ * Prints `Testing Done` to the output in blue text.
42237
42344
  *
42238
42345
  * - **ThreadSafety**: Unsafe
42239
42346
  *
@@ -42242,7 +42349,7 @@ interface TestService extends Instance {
42242
42349
  */
42243
42350
  Done(this: TestService): void;
42244
42351
  /**
42245
- * Prints a red message to the output, prefixed by `TestService:`.
42352
+ * Prints a red error message to the output, prefixed by `TestService:`.
42246
42353
  *
42247
42354
  * - **ThreadSafety**: Unsafe
42248
42355
  *
@@ -42254,7 +42361,7 @@ interface TestService extends Instance {
42254
42361
  */
42255
42362
  Error(this: TestService, description: string, source?: Instance, line?: number): void;
42256
42363
  /**
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.
42364
+ * Indicates a fatal error in a `TestService` run.
42258
42365
  *
42259
42366
  * - **ThreadSafety**: Unsafe
42260
42367
  *
@@ -42266,7 +42373,7 @@ interface TestService extends Instance {
42266
42373
  */
42267
42374
  Fail(this: TestService, description: string, source?: Instance, line?: number): void;
42268
42375
  /**
42269
- * Prints Test message, followed by text to the output, in blue text.
42376
+ * Prints `TestService:` followed by a string to the output in blue text.
42270
42377
  *
42271
42378
  * - **ThreadSafety**: Unsafe
42272
42379
  *
@@ -42278,7 +42385,7 @@ interface TestService extends Instance {
42278
42385
  */
42279
42386
  Message(this: TestService, text: string, source?: Instance, line?: number): void;
42280
42387
  /**
42281
- * Prints whether a condition is true along with description text.
42388
+ * Prints whether a condition is true along with a description string.
42282
42389
  *
42283
42390
  * - **ThreadSafety**: Unsafe
42284
42391
  *
@@ -42306,7 +42413,7 @@ interface TestService extends Instance {
42306
42413
  */
42307
42414
  TakeSnapshot(this: TestService, snapshotname: string): void;
42308
42415
  /**
42309
- * Prints if a condition is true, otherwise prints a warning.
42416
+ * Prints if a condition is `true`, otherwise prints a warning.
42310
42417
  *
42311
42418
  * - **ThreadSafety**: Unsafe
42312
42419
  *
@@ -42327,7 +42434,7 @@ interface TestService extends Instance {
42327
42434
  */
42328
42435
  isFeatureEnabled(this: TestService, name: string): boolean;
42329
42436
  /**
42330
- * Fired when the server should collect a conditional test result.
42437
+ * Fires when the server should collect a conditional test result.
42331
42438
  *
42332
42439
  * - **ThreadSafety**: Unsafe
42333
42440
  *
@@ -42335,7 +42442,7 @@ interface TestService extends Instance {
42335
42442
  */
42336
42443
  readonly ServerCollectConditionalResult: RBXScriptSignal<(condition: boolean, text: string, script: Instance, line: number) => void>;
42337
42444
  /**
42338
- * Fired when the server should collect a test result.
42445
+ * Fires when the server should collect a test result.
42339
42446
  *
42340
42447
  * - **ThreadSafety**: Unsafe
42341
42448
  *
@@ -43657,7 +43764,7 @@ interface TextGenerator extends Instance {
43657
43764
  GenerateTextAsync(this: TextGenerator, request: object): object;
43658
43765
  }
43659
43766
  /**
43660
- * The TextService is a service internally responsible for handling the display of text in the game.
43767
+ * Service internally responsible for handling the display of text.
43661
43768
  *
43662
43769
  * - **Tags**: NotCreatable, Service, NotReplicated
43663
43770
  *
@@ -43678,22 +43785,22 @@ interface TextService extends Instance {
43678
43785
  * - **ThreadSafety**: Unsafe
43679
43786
  *
43680
43787
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextSize)
43681
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43788
+ * @param this Service internally responsible for handling the display of text.
43682
43789
  * @param string The string for which the text size is to be calculated.
43683
- * @param fontSize The integer representing the font size used.
43790
+ * @param fontSize The integer representing the font size used. Does not accept an `FontSize` value.
43684
43791
  * @param font The font used.
43685
- * @param frameSize The `TextLabel.AbsoluteSize` of the text object to be used. Required to compute how the text will wrap.
43792
+ * @param frameSize The `GuiBase2d.AbsoluteSize` of the text object to be used. Required to compute how the text will wrap.
43686
43793
  * @returns The size of the space required, in pixels, by the string with the specified formatting.
43687
43794
  */
43688
43795
  GetTextSize(this: TextService, string: string, fontSize: number, font: CastsToEnum<Enum.Font>, frameSize: Vector2): Vector2;
43689
43796
  /**
43690
- * Chat translation is not supported in legacy chat. This method is no longer supported and should not be used.
43797
+ * Filters and translates a string.
43691
43798
  *
43692
43799
  * - **ThreadSafety**: Unsafe
43693
43800
  * - **Tags**: Yields
43694
43801
  *
43695
43802
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#FilterAndTranslateStringAsync)
43696
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43803
+ * @param this Service internally responsible for handling the display of text.
43697
43804
  * @param stringToFilter
43698
43805
  * @param fromUserId
43699
43806
  * @param targetLocales
@@ -43701,16 +43808,16 @@ interface TextService extends Instance {
43701
43808
  */
43702
43809
  FilterAndTranslateStringAsync(this: TextService, stringToFilter: string, fromUserId: number, targetLocales: Array<unknown>, textContext?: CastsToEnum<Enum.TextFilterContext>): TextFilterTranslatedResult;
43703
43810
  /**
43704
- * Filters a string being received from a user, and returns a `TextFilterResult` which can be used to distribute the correctly filtered text accordingly.
43811
+ * Filters a string being received from a user and returns a `TextFilterResult` which can be used to distribute the correctly filtered text accordingly.
43705
43812
  *
43706
43813
  * - **ThreadSafety**: Unsafe
43707
43814
  * - **Tags**: Yields
43708
43815
  *
43709
43816
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#FilterStringAsync)
43710
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43817
+ * @param this Service internally responsible for handling the display of text.
43711
43818
  * @param stringToFilter The text to be filtered.
43712
- * @param fromUserId The userId of the player filtering the text.
43713
- * @param textContext The context that the filtered message will be used in.
43819
+ * @param fromUserId The `Player.UserId` of the player filtering the text.
43820
+ * @param textContext The context that the filtered message will be used in. This parameter does not impact the filtered result of the query and is only used to improve Roblox's text filtering.
43714
43821
  */
43715
43822
  FilterStringAsync(this: TextService, stringToFilter: string, fromUserId: number, textContext?: CastsToEnum<Enum.TextFilterContext>): TextFilterResult;
43716
43823
  /**
@@ -43720,29 +43827,31 @@ interface TextService extends Instance {
43720
43827
  * - **Tags**: Yields
43721
43828
  *
43722
43829
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#GetFamilyInfoAsync)
43723
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43830
+ * @param this Service internally responsible for handling the display of text.
43724
43831
  * @param assetId Asset ID of the font family to look up.
43725
43832
  * @returns The information about the font family.
43726
43833
  */
43727
43834
  GetFamilyInfoAsync(this: TextService, assetId: ContentId): object;
43728
43835
  /**
43729
- * Calculates the width and height of text given parameters.
43836
+ * Computes the `Vector2` dimensions (in pixels) that will be taken up with text when using a `GetTextBoundsParams` object.
43730
43837
  *
43731
43838
  * - **ThreadSafety**: Unsafe
43732
43839
  * - **Tags**: Yields
43733
43840
  *
43734
43841
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextBoundsAsync)
43735
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43842
+ * @param this Service internally responsible for handling the display of text.
43736
43843
  * @param params A reference to a `GetTextBoundsParams` object.
43737
43844
  * @returns The size of the text as a `Vector2`.
43738
43845
  */
43739
43846
  GetTextBoundsAsync(this: TextService, params: GetTextBoundsParams): Vector2;
43740
43847
  /**
43848
+ * Returns the offset used to up-scale text based on the current `GuiService.PreferredTextSize` setting.
43849
+ *
43741
43850
  * - **ThreadSafety**: Unsafe
43742
43851
  * - **Tags**: Yields
43743
43852
  *
43744
43853
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextSizeOffsetAsync)
43745
- * @param this The TextService is a service internally responsible for handling the display of text in the game.
43854
+ * @param this Service internally responsible for handling the display of text.
43746
43855
  * @param fontSize
43747
43856
  * @param font
43748
43857
  */