@rbxts/types 1.0.860 → 1.0.861

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.
@@ -118,6 +118,7 @@ interface Services {
118
118
  OmniRecommendationsService: OmniRecommendationsService;
119
119
  OpenCloudService: OpenCloudService;
120
120
  PackageUIService: PackageUIService;
121
+ PartyEmulatorService: PartyEmulatorService;
121
122
  PatchBundlerFileWatch: PatchBundlerFileWatch;
122
123
  PathfindingService: PathfindingService;
123
124
  PerformanceControlService: PerformanceControlService;
@@ -258,6 +259,7 @@ interface CreatableInstances {
258
259
  AudioFader: AudioFader;
259
260
  AudioFilter: AudioFilter;
260
261
  AudioFlanger: AudioFlanger;
262
+ AudioGate: AudioGate;
261
263
  AudioLimiter: AudioLimiter;
262
264
  AudioListener: AudioListener;
263
265
  AudioPitchShifter: AudioPitchShifter;
@@ -3247,7 +3249,7 @@ interface AnimationTrack extends Instance {
3247
3249
  */
3248
3250
  readonly Animation: Animation | undefined;
3249
3251
  /**
3250
- * A read only property that returns true when the `AnimationTrack` is playing.
3252
+ * A read-only property that returns true when the `AnimationTrack` is playing.
3251
3253
  *
3252
3254
  * - **ThreadSafety**: ReadSafe
3253
3255
  * - **Tags**: NotReplicated
@@ -3256,7 +3258,7 @@ interface AnimationTrack extends Instance {
3256
3258
  */
3257
3259
  readonly IsPlaying: boolean;
3258
3260
  /**
3259
- * A read only property that returns the length (in seconds) of an `AnimationTrack`. This will return 0 until the animation has fully loaded and thus may not be immediately available.
3261
+ * A read-only property that returns the length (in seconds) of an `AnimationTrack`. This will return `0` until the animation has fully loaded and thus may not be immediately available.
3260
3262
  *
3261
3263
  * - **ThreadSafety**: ReadSafe
3262
3264
  * - **Tags**: NotReplicated
@@ -3281,7 +3283,7 @@ interface AnimationTrack extends Instance {
3281
3283
  */
3282
3284
  Priority: Enum.AnimationPriority;
3283
3285
  /**
3284
- * The Speed of an `AnimationTrack` is a read only property that gives the current playback speed of the `AnimationTrack`. This has a default value of 1. When speed is equal to 1, the amount of time an animation takes to complete is equal to `AnimationTrack.Length` (in seconds).
3286
+ * Read-only property that gives the current playback speed of the `AnimationTrack`.
3285
3287
  *
3286
3288
  * - **ThreadSafety**: ReadSafe
3287
3289
  * - **Tags**: NotReplicated
@@ -3299,7 +3301,7 @@ interface AnimationTrack extends Instance {
3299
3301
  */
3300
3302
  TimePosition: number;
3301
3303
  /**
3302
- * Read-only property that gives the current weight of the `AnimationTrack`. It has a default value of 1.
3304
+ * Read-only property that gives the current weight of the `AnimationTrack`.
3303
3305
  *
3304
3306
  * - **ThreadSafety**: ReadSafe
3305
3307
  * - **Tags**: NotReplicated
@@ -3317,7 +3319,7 @@ interface AnimationTrack extends Instance {
3317
3319
  */
3318
3320
  readonly WeightTarget: number;
3319
3321
  /**
3320
- * Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and 0 pauses it.
3322
+ * Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and `0` pauses it.
3321
3323
  *
3322
3324
  * - **ThreadSafety**: Unsafe
3323
3325
  * - **Tags**: CustomLuaState
@@ -3328,7 +3330,7 @@ interface AnimationTrack extends Instance {
3328
3330
  */
3329
3331
  AdjustSpeed(this: AnimationTrack, speed?: number): void;
3330
3332
  /**
3331
- * Changes the weight of an animation, with the optional fadeTime parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
3333
+ * Changes the weight of an animation, with the optional `fadeTime` parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
3332
3334
  *
3333
3335
  * - **ThreadSafety**: Unsafe
3334
3336
  * - **Tags**: CustomLuaState
@@ -3377,7 +3379,7 @@ interface AnimationTrack extends Instance {
3377
3379
  */
3378
3380
  GetTimeOfKeyframe(this: AnimationTrack, keyframeName: string): number;
3379
3381
  /**
3380
- * Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified fadeTime, weight and speed.
3382
+ * Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified `fadeTime`, weight and speed.
3381
3383
  *
3382
3384
  * - **ThreadSafety**: Unsafe
3383
3385
  * - **Tags**: CustomLuaState
@@ -3418,7 +3420,7 @@ interface AnimationTrack extends Instance {
3418
3420
  */
3419
3421
  readonly DidLoop: RBXScriptSignal<() => void>;
3420
3422
  /**
3421
- * Fires when the `AnimationTrack` is completely done moving anything in the world. The animation has finished playing, the "fade out" is finished, and the subject is in a neutral pose.
3423
+ * Fires when the `AnimationTrack` is completely done moving anything in the world.
3422
3424
  *
3423
3425
  * - **ThreadSafety**: Unsafe
3424
3426
  *
@@ -3426,7 +3428,7 @@ interface AnimationTrack extends Instance {
3426
3428
  */
3427
3429
  readonly Ended: RBXScriptSignal<() => void>;
3428
3430
  /**
3429
- * Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name - "Keyframe.".
3431
+ * Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name of `Keyframe`.
3430
3432
  *
3431
3433
  * - **ThreadSafety**: Unsafe
3432
3434
  *
@@ -3458,7 +3460,7 @@ interface Animator extends Instance {
3458
3460
  readonly _nominal_Animator: unique symbol;
3459
3461
  /**
3460
3462
  * - **ThreadSafety**: Safe
3461
- * - **Tags**: NotReplicated, NotBrowsable
3463
+ * - **Tags**: NotReplicated
3462
3464
  *
3463
3465
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#EvaluationThrottled)
3464
3466
  */
@@ -3751,6 +3753,8 @@ interface AssetService extends Instance {
3751
3753
  * - **ThreadSafety**: Unsafe
3752
3754
  *
3753
3755
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
3756
+ * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
3757
+ * @param content
3754
3758
  */
3755
3759
  CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
3756
3760
  /**
@@ -5472,6 +5476,69 @@ interface AudioFocusService extends Instance {
5472
5476
  */
5473
5477
  readonly _nominal_AudioFocusService: unique symbol;
5474
5478
  }
5479
+ /**
5480
+ * - **Tags**: NotBrowsable
5481
+ *
5482
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
5483
+ */
5484
+ interface AudioGate extends Instance {
5485
+ /**
5486
+ * **DO NOT USE!**
5487
+ *
5488
+ * This field exists to force TypeScript to recognize this as a nominal type
5489
+ * @hidden
5490
+ * @deprecated
5491
+ */
5492
+ readonly _nominal_AudioGate: unique symbol;
5493
+ /**
5494
+ * - **ThreadSafety**: ReadSafe
5495
+ *
5496
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Attack)
5497
+ */
5498
+ Attack: number;
5499
+ /**
5500
+ * - **ThreadSafety**: ReadSafe
5501
+ *
5502
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Bypass)
5503
+ */
5504
+ Bypass: boolean;
5505
+ /**
5506
+ * - **ThreadSafety**: ReadSafe
5507
+ *
5508
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Release)
5509
+ */
5510
+ Release: number;
5511
+ /**
5512
+ * - **ThreadSafety**: ReadSafe
5513
+ *
5514
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Threshold)
5515
+ */
5516
+ Threshold: NumberRange;
5517
+ /**
5518
+ * - **ThreadSafety**: Unsafe
5519
+ *
5520
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
5521
+ */
5522
+ GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
5523
+ /**
5524
+ * - **ThreadSafety**: Unsafe
5525
+ *
5526
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
5527
+ */
5528
+ GetInputPins(this: AudioGate): Array<unknown>;
5529
+ /**
5530
+ * - **ThreadSafety**: Unsafe
5531
+ *
5532
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
5533
+ */
5534
+ GetOutputPins(this: AudioGate): Array<unknown>;
5535
+ /**
5536
+ * - **ThreadSafety**: Unsafe
5537
+ *
5538
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged)
5539
+ */
5540
+ readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
5541
+ }
5475
5542
  /**
5476
5543
  * Limits how loud audio streams are allowed to be.
5477
5544
  *
@@ -6328,8 +6395,6 @@ interface AudioSpeechToText extends Instance {
6328
6395
  /**
6329
6396
  * Plays text as speech audio.
6330
6397
  *
6331
- * - **Tags**: NotBrowsable
6332
- *
6333
6398
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
6334
6399
  */
6335
6400
  interface AudioTextToSpeech extends Instance {
@@ -26003,6 +26068,8 @@ interface MarketplaceService extends Instance {
26003
26068
  * - **Tags**: Yields
26004
26069
  *
26005
26070
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
26071
+ * @param this The service responsible for in-experience transactions.
26072
+ * @param userIds
26006
26073
  */
26007
26074
  GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
26008
26075
  /**
@@ -26742,6 +26809,8 @@ interface ModerationService extends Instance {
26742
26809
  * - **Tags**: Yields
26743
26810
  *
26744
26811
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
26812
+ * @param this
26813
+ * @param config
26745
26814
  */
26746
26815
  InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
26747
26816
  /**
@@ -26749,12 +26818,15 @@ interface ModerationService extends Instance {
26749
26818
  * - **Tags**: Yields
26750
26819
  *
26751
26820
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
26821
+ * @param this
26822
+ * @param config
26752
26823
  */
26753
26824
  InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
26754
26825
  /**
26755
26826
  * - **ThreadSafety**: Unsafe
26756
26827
  *
26757
26828
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
26829
+ * @param event
26758
26830
  */
26759
26831
  InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
26760
26832
  }
@@ -31506,6 +31578,21 @@ interface ParticleEmitter extends Instance {
31506
31578
  */
31507
31579
  readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
31508
31580
  }
31581
+ /**
31582
+ * - **Tags**: NotCreatable, Service, NotReplicated
31583
+ *
31584
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
31585
+ */
31586
+ interface PartyEmulatorService extends Instance {
31587
+ /**
31588
+ * **DO NOT USE!**
31589
+ *
31590
+ * This field exists to force TypeScript to recognize this as a nominal type
31591
+ * @hidden
31592
+ * @deprecated
31593
+ */
31594
+ readonly _nominal_PartyEmulatorService: unique symbol;
31595
+ }
31509
31596
  /**
31510
31597
  * - **Tags**: NotCreatable, Service, NotReplicated
31511
31598
  *
@@ -32150,7 +32237,7 @@ interface PlatformFriendsService extends Instance {
32150
32237
  readonly _nominal_PlatformFriendsService: unique symbol;
32151
32238
  }
32152
32239
  /**
32153
- * An object that represents a presently connected client to the game.
32240
+ * An object that represents a presently connected client to the experience.
32154
32241
  *
32155
32242
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
32156
32243
  */
@@ -32205,7 +32292,7 @@ interface Player extends Instance {
32205
32292
  */
32206
32293
  CameraMode: Enum.CameraMode;
32207
32294
  /**
32208
- * Determines whether the character's appearance will be loaded when the player spawns. If false, the player will spawn with a default appearance.
32295
+ * Determines whether the character's appearance will be loaded when the player spawns. If `false`, the player will spawn with a default appearance.
32209
32296
  *
32210
32297
  * - **ThreadSafety**: ReadSafe
32211
32298
  *
@@ -32234,7 +32321,7 @@ interface Player extends Instance {
32234
32321
  */
32235
32322
  CharacterAppearance: string;
32236
32323
  /**
32237
- * Determines the user ID of the account whose character appearance is used for a player's `character`.
32324
+ * Determines the user ID of the account whose character appearance is used for a player's `Character`.
32238
32325
  *
32239
32326
  * - **ThreadSafety**: ReadSafe
32240
32327
  *
@@ -32276,7 +32363,7 @@ interface Player extends Instance {
32276
32363
  */
32277
32364
  DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
32278
32365
  /**
32279
- * Determines player's camera movement mode when using a desktop version of Roblox.
32366
+ * Determines player's camera movement mode when using a device with a mouse and keyboard.
32280
32367
  *
32281
32368
  * - **ThreadSafety**: ReadSafe
32282
32369
  *
@@ -32284,7 +32371,7 @@ interface Player extends Instance {
32284
32371
  */
32285
32372
  DevComputerCameraMode: Enum.DevComputerCameraMovementMode;
32286
32373
  /**
32287
- * Determines player's character movement mode when using a desktop version of Roblox.
32374
+ * Determines player's character movement mode when using a device with a mouse and keyboard.
32288
32375
  *
32289
32376
  * - **ThreadSafety**: ReadSafe
32290
32377
  *
@@ -32300,7 +32387,7 @@ interface Player extends Instance {
32300
32387
  */
32301
32388
  DevEnableMouseLock: boolean;
32302
32389
  /**
32303
- * Determines player's camera movement mode when using a touch device.
32390
+ * Determines player's camera movement mode when using a touch-enabled device.
32304
32391
  *
32305
32392
  * - **ThreadSafety**: ReadSafe
32306
32393
  *
@@ -32308,7 +32395,7 @@ interface Player extends Instance {
32308
32395
  */
32309
32396
  DevTouchCameraMode: Enum.DevTouchCameraMovementMode;
32310
32397
  /**
32311
- * Determines player's character movement mode when using a touch device.
32398
+ * Determines player's character movement mode when using a touch-enabled device.
32312
32399
  *
32313
32400
  * - **ThreadSafety**: ReadSafe
32314
32401
  *
@@ -32316,7 +32403,7 @@ interface Player extends Instance {
32316
32403
  */
32317
32404
  DevTouchMovementMode: Enum.DevTouchMovementMode;
32318
32405
  /**
32319
- * The DisplayName of the UserId associated with the Player.
32406
+ * The display name of the authenticated user associated with the `Player`.
32320
32407
  *
32321
32408
  * - **ThreadSafety**: ReadSafe
32322
32409
  *
@@ -32324,7 +32411,7 @@ interface Player extends Instance {
32324
32411
  */
32325
32412
  DisplayName: string;
32326
32413
  /**
32327
- * Describes the user ID of the player who was followed into a game by a player.
32414
+ * Describes the user ID of the player who was followed into an experience by a player.
32328
32415
  *
32329
32416
  * - **ThreadSafety**: ReadSafe
32330
32417
  * - **Tags**: NotReplicated
@@ -32341,7 +32428,7 @@ interface Player extends Instance {
32341
32428
  */
32342
32429
  get GameplayPaused(): boolean;
32343
32430
  /**
32344
- * Indicates if a player has a Verified Badge.
32431
+ * Indicates if a player has a **Verified** badge.
32345
32432
  *
32346
32433
  * - **ThreadSafety**: ReadSafe
32347
32434
  *
@@ -32349,7 +32436,7 @@ interface Player extends Instance {
32349
32436
  */
32350
32437
  HasVerifiedBadge: boolean;
32351
32438
  /**
32352
- * Sets the distance at which this player will see other Humanoid's health bars. If set to 0, the health bars will not be displayed.
32439
+ * Sets the distance at which this player will see other players' health bars.
32353
32440
  *
32354
32441
  * - **ThreadSafety**: ReadSafe
32355
32442
  *
@@ -32357,7 +32444,7 @@ interface Player extends Instance {
32357
32444
  */
32358
32445
  HealthDisplayDistance: number;
32359
32446
  /**
32360
- * This property shows the locale id that the local player has set for their Roblox account.
32447
+ * This property shows the locale ID that the local player has set for their Roblox account.
32361
32448
  *
32362
32449
  * - **ThreadSafety**: ReadSafe
32363
32450
  * - **Tags**: Hidden, NotReplicated
@@ -32375,7 +32462,7 @@ interface Player extends Instance {
32375
32462
  */
32376
32463
  readonly MembershipType: Enum.MembershipType;
32377
32464
  /**
32378
- * Sets the distance at which this player will see other Humanoid's names. If set to 0, names are hidden.
32465
+ * Sets the distance at which this player will see other players' names.
32379
32466
  *
32380
32467
  * - **ThreadSafety**: ReadSafe
32381
32468
  *
@@ -32416,7 +32503,7 @@ interface Player extends Instance {
32416
32503
  */
32417
32504
  RespawnLocation: SpawnLocation | undefined;
32418
32505
  /**
32419
- * Determines the Team with which a Player is associated.
32506
+ * Determines the `Team` with which the player is associated.
32420
32507
  *
32421
32508
  * - **ThreadSafety**: ReadSafe
32422
32509
  * - **Tags**: NotReplicated
@@ -32425,7 +32512,7 @@ interface Player extends Instance {
32425
32512
  */
32426
32513
  Team: Team | undefined;
32427
32514
  /**
32428
- * Determines the Team with which a Player is associated.
32515
+ * Determines the `Team` with which the player is associated with according to that team's `Team.TeamColor`.
32429
32516
  *
32430
32517
  * - **ThreadSafety**: ReadSafe
32431
32518
  *
@@ -32444,26 +32531,26 @@ interface Player extends Instance {
32444
32531
  * - **ThreadSafety**: Unsafe
32445
32532
  *
32446
32533
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AddReplicationFocus)
32447
- * @param this An object that represents a presently connected client to the game.
32534
+ * @param this An object that represents a presently connected client to the experience.
32448
32535
  * @param part
32449
32536
  */
32450
32537
  AddReplicationFocus(this: Player, part: BasePart): void;
32451
32538
  /**
32452
- * Removes all accessories and other character appearance objects from a player's Character.
32539
+ * Removes all accessories and other character appearance objects from a player's `Character`.
32453
32540
  *
32454
32541
  * - **ThreadSafety**: Unsafe
32455
32542
  *
32456
32543
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCharacterAppearance)
32457
- * @param this An object that represents a presently connected client to the game.
32544
+ * @param this An object that represents a presently connected client to the experience.
32458
32545
  */
32459
32546
  ClearCharacterAppearance(this: Player): void;
32460
32547
  /**
32461
- * Returns the distance between the character's head and the given Vector3 point. Returns 0 if the player has no character.
32548
+ * Returns the distance between the character's head and the given `Vector3`, or `0` if the player has no character.
32462
32549
  *
32463
32550
  * - **ThreadSafety**: Unsafe
32464
32551
  *
32465
32552
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#DistanceFromCharacter)
32466
- * @param this An object that represents a presently connected client to the game.
32553
+ * @param this An object that represents a presently connected client to the experience.
32467
32554
  * @param point The location from which player's distance to is being measured.
32468
32555
  * @returns The distance in studs between the player and the location.
32469
32556
  */
@@ -32475,13 +32562,13 @@ interface Player extends Instance {
32475
32562
  */
32476
32563
  GetData(this: Player): PlayerData;
32477
32564
  /**
32478
- * Returns a dictionary containing information describing how the `Player` joins the experience.
32565
+ * Returns a dictionary containing information describing how the player joins the experience.
32479
32566
  *
32480
32567
  * - **ThreadSafety**: Unsafe
32481
32568
  * - **Tags**: CustomLuaState
32482
32569
  *
32483
32570
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetJoinData)
32484
- * @param this An object that represents a presently connected client to the game.
32571
+ * @param this An object that represents a presently connected client to the experience.
32485
32572
  * @returns A dictionary containing PlaceId and UserId values (see table in description).
32486
32573
  */
32487
32574
  GetJoinData(this: Player): PlayerJoinInfo;
@@ -32491,7 +32578,7 @@ interface Player extends Instance {
32491
32578
  * - **ThreadSafety**: Unsafe
32492
32579
  *
32493
32580
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetMouse)
32494
- * @param this An object that represents a presently connected client to the game.
32581
+ * @param this An object that represents a presently connected client to the experience.
32495
32582
  */
32496
32583
  GetMouse(this: Player): PlayerMouse;
32497
32584
  /**
@@ -32500,7 +32587,7 @@ interface Player extends Instance {
32500
32587
  * - **ThreadSafety**: Safe
32501
32588
  *
32502
32589
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetNetworkPing)
32503
- * @param this An object that represents a presently connected client to the game.
32590
+ * @param this An object that represents a presently connected client to the experience.
32504
32591
  */
32505
32592
  GetNetworkPing(this: Player): number;
32506
32593
  /**
@@ -32509,7 +32596,7 @@ interface Player extends Instance {
32509
32596
  * - **ThreadSafety**: Unsafe
32510
32597
  *
32511
32598
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasAppearanceLoaded)
32512
- * @param this An object that represents a presently connected client to the game.
32599
+ * @param this An object that represents a presently connected client to the experience.
32513
32600
  * @returns A boolean indicating whether or not the appearance of the player's character has loaded.
32514
32601
  */
32515
32602
  HasAppearanceLoaded(this: Player): boolean;
@@ -32519,17 +32606,17 @@ interface Player extends Instance {
32519
32606
  * - **ThreadSafety**: Unsafe
32520
32607
  *
32521
32608
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsVerified)
32522
- * @param this An object that represents a presently connected client to the game.
32609
+ * @param this An object that represents a presently connected client to the experience.
32523
32610
  * @returns A boolean indicating whether the player is verified.
32524
32611
  */
32525
32612
  IsVerified(this: Player): boolean;
32526
32613
  /**
32527
- * Forcibly disconnect a player from the game, optionally providing a message.
32614
+ * Forcibly disconnect a player from the experience, optionally providing a message.
32528
32615
  *
32529
32616
  * - **ThreadSafety**: Unsafe
32530
32617
  *
32531
32618
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Kick)
32532
- * @param this An object that represents a presently connected client to the game.
32619
+ * @param this An object that represents a presently connected client to the experience.
32533
32620
  * @param message The message to show the user upon kicking.
32534
32621
  */
32535
32622
  Kick(this: Player, message?: string): void;
@@ -32542,7 +32629,7 @@ interface Player extends Instance {
32542
32629
  * - **Tags**:
32543
32630
  *
32544
32631
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadBoolean)
32545
- * @param this An object that represents a presently connected client to the game.
32632
+ * @param this An object that represents a presently connected client to the experience.
32546
32633
  * @param key
32547
32634
  *
32548
32635
  * @deprecated
@@ -32557,7 +32644,7 @@ interface Player extends Instance {
32557
32644
  * - **Tags**:
32558
32645
  *
32559
32646
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAppearance)
32560
- * @param this An object that represents a presently connected client to the game.
32647
+ * @param this An object that represents a presently connected client to the experience.
32561
32648
  * @param assetInstance An instance of the asset being loaded, which can be obtained using the `InsertService:LoadAsset()` function.
32562
32649
  *
32563
32650
  * @deprecated
@@ -32572,7 +32659,7 @@ interface Player extends Instance {
32572
32659
  * - **Tags**:
32573
32660
  *
32574
32661
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadInstance)
32575
- * @param this An object that represents a presently connected client to the game.
32662
+ * @param this An object that represents a presently connected client to the experience.
32576
32663
  * @param key
32577
32664
  *
32578
32665
  * @deprecated
@@ -32587,7 +32674,7 @@ interface Player extends Instance {
32587
32674
  * - **Tags**:
32588
32675
  *
32589
32676
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadNumber)
32590
- * @param this An object that represents a presently connected client to the game.
32677
+ * @param this An object that represents a presently connected client to the experience.
32591
32678
  * @param key
32592
32679
  *
32593
32680
  * @deprecated
@@ -32602,7 +32689,7 @@ interface Player extends Instance {
32602
32689
  * - **Tags**:
32603
32690
  *
32604
32691
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadString)
32605
- * @param this An object that represents a presently connected client to the game.
32692
+ * @param this An object that represents a presently connected client to the experience.
32606
32693
  * @param key
32607
32694
  *
32608
32695
  * @deprecated
@@ -32614,7 +32701,7 @@ interface Player extends Instance {
32614
32701
  * - **ThreadSafety**: Unsafe
32615
32702
  *
32616
32703
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Move)
32617
- * @param this An object that represents a presently connected client to the game.
32704
+ * @param this An object that represents a presently connected client to the experience.
32618
32705
  * @param walkDirection The Vector3 direction that the player should move.
32619
32706
  * @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
32620
32707
  */
@@ -32623,7 +32710,7 @@ interface Player extends Instance {
32623
32710
  * - **ThreadSafety**: Unsafe
32624
32711
  *
32625
32712
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RemoveReplicationFocus)
32626
- * @param this An object that represents a presently connected client to the game.
32713
+ * @param this An object that represents a presently connected client to the experience.
32627
32714
  * @param part
32628
32715
  */
32629
32716
  RemoveReplicationFocus(this: Player, part: BasePart): void;
@@ -32636,7 +32723,7 @@ interface Player extends Instance {
32636
32723
  * - **Tags**:
32637
32724
  *
32638
32725
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveBoolean)
32639
- * @param this An object that represents a presently connected client to the game.
32726
+ * @param this An object that represents a presently connected client to the experience.
32640
32727
  * @param key
32641
32728
  * @param value
32642
32729
  *
@@ -32652,7 +32739,7 @@ interface Player extends Instance {
32652
32739
  * - **Tags**:
32653
32740
  *
32654
32741
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveInstance)
32655
- * @param this An object that represents a presently connected client to the game.
32742
+ * @param this An object that represents a presently connected client to the experience.
32656
32743
  * @param key
32657
32744
  * @param value
32658
32745
  *
@@ -32668,7 +32755,7 @@ interface Player extends Instance {
32668
32755
  * - **Tags**:
32669
32756
  *
32670
32757
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveNumber)
32671
- * @param this An object that represents a presently connected client to the game.
32758
+ * @param this An object that represents a presently connected client to the experience.
32672
32759
  * @param key
32673
32760
  * @param value
32674
32761
  *
@@ -32684,7 +32771,7 @@ interface Player extends Instance {
32684
32771
  * - **Tags**:
32685
32772
  *
32686
32773
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveString)
32687
- * @param this An object that represents a presently connected client to the game.
32774
+ * @param this An object that represents a presently connected client to the experience.
32688
32775
  * @param key
32689
32776
  * @param value
32690
32777
  *
@@ -32698,33 +32785,33 @@ interface Player extends Instance {
32698
32785
  * - **Tags**: Yields
32699
32786
  *
32700
32787
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
32701
- * @param this An object that represents a presently connected client to the game.
32788
+ * @param this An object that represents a presently connected client to the experience.
32702
32789
  * @param maxFriends The maximum number of online friends to return.
32703
32790
  * @returns A dictionary of online friends (see the table above).
32704
32791
  */
32705
32792
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
32706
32793
  /**
32707
- * Returns the player's rank in the group as an integer between 0 and 255, where 0 is a non-member and 255 is the group's owner.
32794
+ * Returns the player's rank in the group as an integer.
32708
32795
  *
32709
32796
  * - **ThreadSafety**: Unsafe
32710
32797
  * - **Tags**: Yields
32711
32798
  *
32712
32799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroup)
32713
- * @param this An object that represents a presently connected client to the game.
32800
+ * @param this An object that represents a presently connected client to the experience.
32714
32801
  * @param groupId The `groupId` of the specified group.
32715
32802
  * @returns The player's rank in the group.
32716
32803
  */
32717
32804
  GetRankInGroup(this: Player, groupId: number): number;
32718
32805
  /**
32719
- * Returns the player's role in the group as a string, or "Guest" if the player isn't part of the group.
32806
+ * Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
32720
32807
  *
32721
32808
  * - **ThreadSafety**: Unsafe
32722
32809
  * - **Tags**: Yields
32723
32810
  *
32724
32811
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroup)
32725
- * @param this An object that represents a presently connected client to the game.
32726
- * @param groupId The *groupId* of the specified group.
32727
- * @returns The player's role in the specified group, or *Guest* if the player is not a member.
32812
+ * @param this An object that represents a presently connected client to the experience.
32813
+ * @param groupId The group ID of the specified group.
32814
+ * @returns The player's role in the specified group, or `Guest` if the player is not a member.
32728
32815
  */
32729
32816
  GetRoleInGroup(this: Player, groupId: number): string;
32730
32817
  /**
@@ -32736,7 +32823,7 @@ interface Player extends Instance {
32736
32823
  * - **Tags**: Yields
32737
32824
  *
32738
32825
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsBestFriendsWith)
32739
- * @param this An object that represents a presently connected client to the game.
32826
+ * @param this An object that represents a presently connected client to the experience.
32740
32827
  * @param userId
32741
32828
  *
32742
32829
  * @deprecated
@@ -32749,7 +32836,7 @@ interface Player extends Instance {
32749
32836
  * - **Tags**: Yields
32750
32837
  *
32751
32838
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
32752
- * @param this An object that represents a presently connected client to the game.
32839
+ * @param this An object that represents a presently connected client to the experience.
32753
32840
  * @param userId The `Player.UserId` of the specified player.
32754
32841
  * @returns A boolean indicating whether a player is a friend of the specified user.
32755
32842
  */
@@ -32761,8 +32848,8 @@ interface Player extends Instance {
32761
32848
  * - **Tags**: Yields
32762
32849
  *
32763
32850
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroup)
32764
- * @param this An object that represents a presently connected client to the game.
32765
- * @param groupId The *groupId* of the specified group.
32851
+ * @param this An object that represents a presently connected client to the experience.
32852
+ * @param groupId The group ID of the specified group.
32766
32853
  * @returns A boolean indicating whether the player is in the specified group.
32767
32854
  */
32768
32855
  IsInGroup(this: Player, groupId: number): boolean;
@@ -32773,17 +32860,17 @@ interface Player extends Instance {
32773
32860
  * - **Tags**: Yields
32774
32861
  *
32775
32862
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
32776
- * @param this An object that represents a presently connected client to the game.
32863
+ * @param this An object that represents a presently connected client to the experience.
32777
32864
  */
32778
32865
  LoadCharacter(this: Player): void;
32779
32866
  /**
32780
- * Spawns an avatar so it has everything equipped in the passed in `HumanoidDescription`.
32867
+ * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
32781
32868
  *
32782
32869
  * - **ThreadSafety**: Unsafe
32783
32870
  * - **Tags**: Yields
32784
32871
  *
32785
32872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription)
32786
- * @param this An object that represents a presently connected client to the game.
32873
+ * @param this An object that represents a presently connected client to the experience.
32787
32874
  * @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
32788
32875
  */
32789
32876
  LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
@@ -32794,7 +32881,7 @@ interface Player extends Instance {
32794
32881
  * - **Tags**: Yields
32795
32882
  *
32796
32883
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RequestStreamAroundAsync)
32797
- * @param this An object that represents a presently connected client to the game.
32884
+ * @param this An object that represents a presently connected client to the experience.
32798
32885
  * @param position World location where streaming is requested.
32799
32886
  * @param timeOut Optional timeout for the request, the maximum duration that the engine attempts to stream regions around the `position` parameter before abandoning the request. If you don't specify a value, the timeout is effectively infinite. However, if the client is low on memory, the engine abandons all streaming requests, even those that are still within the timeout duration.
32800
32887
  */
@@ -32808,13 +32895,13 @@ interface Player extends Instance {
32808
32895
  * - **Tags**: Yields
32809
32896
  *
32810
32897
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#WaitForDataReady)
32811
- * @param this An object that represents a presently connected client to the game.
32898
+ * @param this An object that represents a presently connected client to the experience.
32812
32899
  *
32813
32900
  * @deprecated
32814
32901
  */
32815
32902
  WaitForDataReady(this: Player): boolean;
32816
32903
  /**
32817
- * Fired when a player's character spawns or respawns.
32904
+ * Fires when a player's character spawns or respawns.
32818
32905
  *
32819
32906
  * - **ThreadSafety**: Unsafe
32820
32907
  *
@@ -32822,7 +32909,7 @@ interface Player extends Instance {
32822
32909
  */
32823
32910
  readonly CharacterAdded: RBXScriptSignal<(character: Model) => void>;
32824
32911
  /**
32825
- * Fires when the full appearance of a `Player.Character` has been inserted.
32912
+ * Fires when the full appearance of a `Character` has been inserted.
32826
32913
  *
32827
32914
  * - **ThreadSafety**: Unsafe
32828
32915
  *
@@ -32830,7 +32917,7 @@ interface Player extends Instance {
32830
32917
  */
32831
32918
  readonly CharacterAppearanceLoaded: RBXScriptSignal<(character: Model) => void>;
32832
32919
  /**
32833
- * Fired right before a player's character is removed.
32920
+ * Fires right before a player's character is removed.
32834
32921
  *
32835
32922
  * - **ThreadSafety**: Unsafe
32836
32923
  *
@@ -32838,7 +32925,7 @@ interface Player extends Instance {
32838
32925
  */
32839
32926
  readonly CharacterRemoving: RBXScriptSignal<(character: Model) => void>;
32840
32927
  /**
32841
- * Fires when a player chats in-game using Roblox's provided chat bar.
32928
+ * Fires when a player chats in experience using Roblox's provided chat bar.
32842
32929
  *
32843
32930
  * - **ThreadSafety**: Unsafe
32844
32931
  *
@@ -32846,7 +32933,7 @@ interface Player extends Instance {
32846
32933
  */
32847
32934
  readonly Chatted: RBXScriptSignal<(message: string, recipient?: Player) => void>;
32848
32935
  /**
32849
- * This event fires approximately two minutes after the game engine classifies the `player` as idle. Time is the number of seconds that have elapsed since that point.
32936
+ * This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point.
32850
32937
  *
32851
32938
  * - **ThreadSafety**: Unsafe
32852
32939
  *
@@ -32854,7 +32941,7 @@ interface Player extends Instance {
32854
32941
  */
32855
32942
  readonly Idled: RBXScriptSignal<(time: number) => void>;
32856
32943
  /**
32857
- * Fired when the TeleportState of a player changes.
32944
+ * Fires when the teleport state of a player changes.
32858
32945
  *
32859
32946
  * - **ThreadSafety**: Unsafe
32860
32947
  *
@@ -34416,12 +34503,22 @@ interface RecommendationService extends Instance {
34416
34503
  * - **ThreadSafety**: Unsafe
34417
34504
  *
34418
34505
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent)
34506
+ * @param this
34507
+ * @param actionType
34508
+ * @param itemId
34509
+ * @param tracingId
34510
+ * @param actionEventDetails
34419
34511
  */
34420
34512
  LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
34421
34513
  /**
34422
34514
  * - **ThreadSafety**: Unsafe
34423
34515
  *
34424
34516
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent)
34517
+ * @param this
34518
+ * @param impressionType
34519
+ * @param itemId
34520
+ * @param tracingId
34521
+ * @param impressionEventDetails
34425
34522
  */
34426
34523
  LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
34427
34524
  /**
@@ -34429,6 +34526,8 @@ interface RecommendationService extends Instance {
34429
34526
  * - **Tags**: Yields
34430
34527
  *
34431
34528
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync)
34529
+ * @param this
34530
+ * @param generateRecommendationItemListRequest
34432
34531
  */
34433
34532
  GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
34434
34533
  /**
@@ -34436,6 +34535,8 @@ interface RecommendationService extends Instance {
34436
34535
  * - **Tags**: Yields
34437
34536
  *
34438
34537
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
34538
+ * @param this
34539
+ * @param registerRecommendationItemsRequest
34439
34540
  */
34440
34541
  RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
34441
34542
  /**
@@ -34443,6 +34544,8 @@ interface RecommendationService extends Instance {
34443
34544
  * - **Tags**: Yields
34444
34545
  *
34445
34546
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RemoveItemAsync)
34547
+ * @param this
34548
+ * @param itemId
34446
34549
  */
34447
34550
  RemoveItemAsync(this: RecommendationService, itemId: string): void;
34448
34551
  /**
@@ -34450,6 +34553,8 @@ interface RecommendationService extends Instance {
34450
34553
  * - **Tags**: Yields
34451
34554
  *
34452
34555
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync)
34556
+ * @param this
34557
+ * @param updateRecommendationItemRequest
34453
34558
  */
34454
34559
  UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
34455
34560
  }
@@ -36475,6 +36580,13 @@ interface SocialService extends Instance {
36475
36580
  * @returns An array of dictionaries representing the members of the specified party who are currently in the experience.
36476
36581
  */
36477
36582
  GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
36583
+ /**
36584
+ * - **ThreadSafety**: Unsafe
36585
+ * - **Tags**: Yields
36586
+ *
36587
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
36588
+ */
36589
+ PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
36478
36590
  /**
36479
36591
  * Prompts the local `Player` with a prompt to change their RSVP status to the given event.
36480
36592
  *
@@ -36511,6 +36623,12 @@ interface SocialService extends Instance {
36511
36623
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PhoneBookPromptClosed)
36512
36624
  */
36513
36625
  readonly PhoneBookPromptClosed: RBXScriptSignal<(player: Player) => void>;
36626
+ /**
36627
+ * - **ThreadSafety**: Unsafe
36628
+ *
36629
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#ShareSheetClosed)
36630
+ */
36631
+ readonly ShareSheetClosed: RBXScriptSignal<(player: Player) => void>;
36514
36632
  /**
36515
36633
  * Callback for when a call is placed from the phone book.
36516
36634
  *
@@ -39442,6 +39560,8 @@ interface TestService extends Instance {
39442
39560
  * - **ThreadSafety**: Unsafe
39443
39561
  *
39444
39562
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
39563
+ * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
39564
+ * @param snapshotname
39445
39565
  */
39446
39566
  TakeSnapshot(this: TestService, snapshotname: string): void;
39447
39567
  /**
@@ -125,6 +125,7 @@ interface Services {
125
125
  OpenCloudService: OpenCloudService;
126
126
  PackageService: PackageService;
127
127
  PackageUIService: PackageUIService;
128
+ PartyEmulatorService: PartyEmulatorService;
128
129
  PatchBundlerFileWatch: PatchBundlerFileWatch;
129
130
  PathfindingService: PathfindingService;
130
131
  PerformanceControlService: PerformanceControlService;
@@ -276,6 +277,7 @@ interface CreatableInstances {
276
277
  AudioFader: AudioFader;
277
278
  AudioFilter: AudioFilter;
278
279
  AudioFlanger: AudioFlanger;
280
+ AudioGate: AudioGate;
279
281
  AudioLimiter: AudioLimiter;
280
282
  AudioListener: AudioListener;
281
283
  AudioPitchShifter: AudioPitchShifter;
@@ -1719,6 +1721,21 @@ interface AudioFocusService extends Instance {
1719
1721
  */
1720
1722
  readonly _nominal_AudioFocusService: unique symbol;
1721
1723
  }
1724
+ /**
1725
+ * - **Tags**: NotBrowsable
1726
+ *
1727
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
1728
+ */
1729
+ interface AudioGate extends Instance {
1730
+ /**
1731
+ * **DO NOT USE!**
1732
+ *
1733
+ * This field exists to force TypeScript to recognize this as a nominal type
1734
+ * @hidden
1735
+ * @deprecated
1736
+ */
1737
+ readonly _nominal_AudioGate: unique symbol;
1738
+ }
1722
1739
  /**
1723
1740
  * Limits how loud audio streams are allowed to be.
1724
1741
  *
@@ -1846,8 +1863,6 @@ interface AudioSpeechToText extends Instance {
1846
1863
  /**
1847
1864
  * Plays text as speech audio.
1848
1865
  *
1849
- * - **Tags**: NotBrowsable
1850
- *
1851
1866
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
1852
1867
  */
1853
1868
  interface AudioTextToSpeech extends Instance {
@@ -9395,6 +9410,21 @@ interface ParticleEmitter extends Instance {
9395
9410
  */
9396
9411
  readonly _nominal_ParticleEmitter: unique symbol;
9397
9412
  }
9413
+ /**
9414
+ * - **Tags**: NotCreatable, Service, NotReplicated
9415
+ *
9416
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
9417
+ */
9418
+ interface PartyEmulatorService extends Instance {
9419
+ /**
9420
+ * **DO NOT USE!**
9421
+ *
9422
+ * This field exists to force TypeScript to recognize this as a nominal type
9423
+ * @hidden
9424
+ * @deprecated
9425
+ */
9426
+ readonly _nominal_PartyEmulatorService: unique symbol;
9427
+ }
9398
9428
  /**
9399
9429
  * - **Tags**: NotCreatable, Service, NotReplicated
9400
9430
  *
@@ -9655,7 +9685,7 @@ interface PlatformFriendsService extends Instance {
9655
9685
  readonly _nominal_PlatformFriendsService: unique symbol;
9656
9686
  }
9657
9687
  /**
9658
- * An object that represents a presently connected client to the game.
9688
+ * An object that represents a presently connected client to the experience.
9659
9689
  *
9660
9690
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
9661
9691
  */
@@ -9669,12 +9699,12 @@ interface Player extends Instance {
9669
9699
  */
9670
9700
  readonly _nominal_Player: unique symbol;
9671
9701
  /**
9672
- * Sets the AccountAge of the player.
9702
+ * Sets the `AccountAge` of the player.
9673
9703
  *
9674
9704
  * - **ThreadSafety**: Unsafe
9675
9705
  *
9676
9706
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetAccountAge)
9677
- * @param this An object that represents a presently connected client to the game.
9707
+ * @param this An object that represents a presently connected client to the experience.
9678
9708
  * @param accountAge The age of the account in days.
9679
9709
  */
9680
9710
  SetAccountAge(this: Player, accountAge: number): void;
@@ -9684,7 +9714,7 @@ interface Player extends Instance {
9684
9714
  * - **ThreadSafety**: Unsafe
9685
9715
  *
9686
9716
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SetSuperSafeChat)
9687
- * @param this An object that represents a presently connected client to the game.
9717
+ * @param this An object that represents a presently connected client to the experience.
9688
9718
  * @param value A boolean indicating whether or not the player sees filtered chat.
9689
9719
  */
9690
9720
  SetSuperSafeChat(this: Player, value: boolean): void;
@@ -11497,6 +11527,7 @@ interface ScriptEditorService extends Instance {
11497
11527
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync)
11498
11528
  * @param this This service is used for interacting with `ScriptDocument` instances.
11499
11529
  * @param script
11530
+ * @param options
11500
11531
  */
11501
11532
  OpenScriptDocumentAsync(this: ScriptEditorService, script: LuaSourceContainer, options?: object): unknown;
11502
11533
  /**
@@ -9943,6 +9943,42 @@ declare namespace Enum {
9943
9943
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DialogTone | undefined;
9944
9944
  }
9945
9945
  export type DialogTone = DialogTone.Neutral | DialogTone.Friendly | DialogTone.Enemy;
9946
+ /**
9947
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize)
9948
+ */
9949
+ export namespace DisplaySize {
9950
+ /**
9951
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small)
9952
+ */
9953
+ export interface Small extends globalThis.EnumItem {
9954
+ Name: "Small";
9955
+ Value: 0;
9956
+ EnumType: typeof globalThis.Enum.DisplaySize;
9957
+ }
9958
+ export const Small: Small;
9959
+ /**
9960
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium)
9961
+ */
9962
+ export interface Medium extends globalThis.EnumItem {
9963
+ Name: "Medium";
9964
+ Value: 1;
9965
+ EnumType: typeof globalThis.Enum.DisplaySize;
9966
+ }
9967
+ export const Medium: Medium;
9968
+ /**
9969
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large)
9970
+ */
9971
+ export interface Large extends globalThis.EnumItem {
9972
+ Name: "Large";
9973
+ Value: 2;
9974
+ EnumType: typeof globalThis.Enum.DisplaySize;
9975
+ }
9976
+ export const Large: Large;
9977
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DisplaySize>;
9978
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DisplaySize | undefined;
9979
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DisplaySize | undefined;
9980
+ }
9981
+ export type DisplaySize = DisplaySize.Small | DisplaySize.Medium | DisplaySize.Large;
9946
9982
  /**
9947
9983
  * Used by `UIAspectRatioConstraint.DominantAxis` for resizing the object to maintain the aspect ratio.
9948
9984
  *
@@ -19908,7 +19944,7 @@ declare namespace Enum {
19908
19944
  }
19909
19945
  export const Glacier: Glacier;
19910
19946
  /**
19911
- * Applies to `BasePart` only.
19947
+ * Applies to `BasePart` only. Note that refraction of light through this material is not supported on mobile devices due to computational limitations.
19912
19948
  *
19913
19949
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#Glass)
19914
19950
  */
@@ -19919,7 +19955,7 @@ declare namespace Enum {
19919
19955
  }
19920
19956
  export const Glass: Glass;
19921
19957
  /**
19922
- * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example of the **ForceField** material.
19958
+ * Must be used on a `MeshPart` with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The `MeshPart` must also have a texture applied to its `TextureID`, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain [this model](https://create.roblox.com/store/asset/15507769146/ForceFieldMesh) for a functional example.
19923
19959
  *
19924
19960
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/Material#ForceField)
19925
19961
  */
@@ -23499,6 +23535,42 @@ declare namespace Enum {
23499
23535
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptCreateAvatarResult | undefined;
23500
23536
  }
23501
23537
  export type PromptCreateAvatarResult = PromptCreateAvatarResult.Success | PromptCreateAvatarResult.PermissionDenied | PromptCreateAvatarResult.Timeout | PromptCreateAvatarResult.UploadFailed | PromptCreateAvatarResult.NoUserInput | PromptCreateAvatarResult.InvalidHumanoidDescription | PromptCreateAvatarResult.UGCValidationFailed | PromptCreateAvatarResult.ModeratedName | PromptCreateAvatarResult.MaxOutfits | PromptCreateAvatarResult.PurchaseFailure | PromptCreateAvatarResult.UnknownFailure | PromptCreateAvatarResult.TokenInvalid;
23538
+ /**
23539
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult)
23540
+ */
23541
+ export namespace PromptLinkSharingResult {
23542
+ /**
23543
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#Success)
23544
+ */
23545
+ export interface Success extends globalThis.EnumItem {
23546
+ Name: "Success";
23547
+ Value: 1;
23548
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23549
+ }
23550
+ export const Success: Success;
23551
+ /**
23552
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#PlayerLeft)
23553
+ */
23554
+ export interface PlayerLeft extends globalThis.EnumItem {
23555
+ Name: "PlayerLeft";
23556
+ Value: 2;
23557
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23558
+ }
23559
+ export const PlayerLeft: PlayerLeft;
23560
+ /**
23561
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptLinkSharingResult#InvalidLaunchData)
23562
+ */
23563
+ export interface InvalidLaunchData extends globalThis.EnumItem {
23564
+ Name: "InvalidLaunchData";
23565
+ Value: 3;
23566
+ EnumType: typeof globalThis.Enum.PromptLinkSharingResult;
23567
+ }
23568
+ export const InvalidLaunchData: InvalidLaunchData;
23569
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PromptLinkSharingResult>;
23570
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PromptLinkSharingResult | undefined;
23571
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PromptLinkSharingResult | undefined;
23572
+ }
23573
+ export type PromptLinkSharingResult = PromptLinkSharingResult.Success | PromptLinkSharingResult.PlayerLeft | PromptLinkSharingResult.InvalidLaunchData;
23502
23574
  /**
23503
23575
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult)
23504
23576
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.860",
3
+ "version": "1.0.861",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },