@rbxts/types 1.0.841 → 1.0.843

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.
@@ -206,6 +206,7 @@ interface Services {
206
206
  VoiceChatService: VoiceChatService;
207
207
  VRService: VRService;
208
208
  VRStatusService: VRStatusService;
209
+ WebSocketService: WebSocketService;
209
210
  WebViewService: WebViewService;
210
211
  Workspace: Workspace;
211
212
  }
@@ -664,6 +665,7 @@ interface Instances extends Services, CreatableInstances {
664
665
  UserGameSettings: UserGameSettings;
665
666
  UserSettings: UserSettings;
666
667
  ValueBase: ValueBase;
668
+ WebSocketClient: WebSocketClient;
667
669
  WorldRoot: WorldRoot;
668
670
  }
669
671
  interface Objects extends Instances {
@@ -1738,7 +1740,7 @@ interface Instance extends RBXObject {
1738
1740
  *
1739
1741
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified)
1740
1742
  * @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
1741
- * @param name Name of the property to query.
1743
+ * @param property
1742
1744
  * @returns Boolean indicating whether the property is modified.
1743
1745
  */
1744
1746
  IsPropertyModified(this: Instance, property: string): boolean;
@@ -1757,7 +1759,7 @@ interface Instance extends RBXObject {
1757
1759
  *
1758
1760
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#ResetPropertyToDefault)
1759
1761
  * @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
1760
- * @param name Name of the property to reset.
1762
+ * @param property
1761
1763
  */
1762
1764
  ResetPropertyToDefault(this: Instance, property: string): void;
1763
1765
  /**
@@ -2839,6 +2841,18 @@ interface AnimationTrack extends Instance {
2839
2841
  * @returns The signal created and fired when the animation reaches the created `KeyFrameMarker`.
2840
2842
  */
2841
2843
  GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
2844
+ /**
2845
+ * - **ThreadSafety**: Unsafe
2846
+ *
2847
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
2848
+ */
2849
+ GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
2850
+ /**
2851
+ * - **ThreadSafety**: Unsafe
2852
+ *
2853
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
2854
+ */
2855
+ GetTargetNames(this: AnimationTrack): Array<unknown>;
2842
2856
  /**
2843
2857
  * Returns the time position of the first `Keyframe` of the given name in an `AnimationTrack`.
2844
2858
  *
@@ -2863,6 +2877,12 @@ interface AnimationTrack extends Instance {
2863
2877
  * @param speed The playback speed of the animation.
2864
2878
  */
2865
2879
  Play(this: AnimationTrack, fadeTime?: number, weight?: number, speed?: number): void;
2880
+ /**
2881
+ * - **ThreadSafety**: Unsafe
2882
+ *
2883
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
2884
+ */
2885
+ SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
2866
2886
  /**
2867
2887
  * Stops the `AnimationTrack`.
2868
2888
  *
@@ -5629,6 +5649,8 @@ interface AudioSearchParams extends Instance {
5629
5649
  Title: string;
5630
5650
  }
5631
5651
  /**
5652
+ * - **Tags**: NotBrowsable
5653
+ *
5632
5654
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
5633
5655
  */
5634
5656
  interface AudioTextToSpeech extends Instance {
@@ -5712,24 +5734,29 @@ interface AudioTextToSpeech extends Instance {
5712
5734
  * - **ThreadSafety**: Unsafe
5713
5735
  *
5714
5736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires)
5737
+ * @param this
5738
+ * @param pin
5715
5739
  */
5716
5740
  GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
5717
5741
  /**
5718
5742
  * - **ThreadSafety**: Unsafe
5719
5743
  *
5720
5744
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pause)
5745
+ * @param this
5721
5746
  */
5722
5747
  Pause(this: AudioTextToSpeech): void;
5723
5748
  /**
5724
5749
  * - **ThreadSafety**: Unsafe
5725
5750
  *
5726
5751
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Play)
5752
+ * @param this
5727
5753
  */
5728
5754
  Play(this: AudioTextToSpeech): void;
5729
5755
  /**
5730
5756
  * - **ThreadSafety**: Unsafe
5731
5757
  *
5732
5758
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Unload)
5759
+ * @param this
5733
5760
  */
5734
5761
  Unload(this: AudioTextToSpeech): void;
5735
5762
  /**
@@ -5737,6 +5764,9 @@ interface AudioTextToSpeech extends Instance {
5737
5764
  * - **Tags**: Yields
5738
5765
  *
5739
5766
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync)
5767
+ * @param this
5768
+ * @param timeRange
5769
+ * @param samples
5740
5770
  */
5741
5771
  GetWaveformAsync(this: AudioTextToSpeech, timeRange: NumberRange, samples: number): Array<unknown>;
5742
5772
  /**
@@ -5744,6 +5774,7 @@ interface AudioTextToSpeech extends Instance {
5744
5774
  * - **Tags**: Yields
5745
5775
  *
5746
5776
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#LoadAsync)
5777
+ * @param this
5747
5778
  */
5748
5779
  LoadAsync(this: AudioTextToSpeech): Enum.AssetFetchStatus;
5749
5780
  /**
@@ -5788,18 +5819,11 @@ interface AuroraScriptService extends Instance {
5788
5819
  */
5789
5820
  get BufferSize(): number;
5790
5821
  /**
5791
- * - **ThreadSafety**: ReadSafe
5792
- * - **Tags**: NotReplicated
5793
- *
5794
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#LocalFrameId)
5795
- */
5796
- get LocalFrameId(): number;
5797
- /**
5798
- * - **ThreadSafety**: ReadSafe
5822
+ * - **ThreadSafety**: Safe
5799
5823
  *
5800
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#RemoteFrameId)
5824
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
5801
5825
  */
5802
- get RemoteFrameId(): number;
5826
+ GetLocalFrameId(this: AuroraScriptService): number;
5803
5827
  /**
5804
5828
  * - **ThreadSafety**: Safe
5805
5829
  *
@@ -5841,12 +5865,6 @@ interface AuroraService extends Instance {
5841
5865
  * @deprecated
5842
5866
  */
5843
5867
  readonly _nominal_AuroraService: unique symbol;
5844
- /**
5845
- * - **ThreadSafety**: ReadSafe
5846
- *
5847
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackEnabled)
5848
- */
5849
- RollbackEnabled: boolean;
5850
5868
  /**
5851
5869
  * - **ThreadSafety**: Unsafe
5852
5870
  *
@@ -5877,18 +5895,6 @@ interface AuroraService extends Instance {
5877
5895
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsDesynced)
5878
5896
  */
5879
5897
  IsDesynced(this: AuroraService, target: Instance): boolean;
5880
- /**
5881
- * - **ThreadSafety**: Unsafe
5882
- *
5883
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#NetDesync)
5884
- */
5885
- NetDesync(this: AuroraService, target: Instance): void;
5886
- /**
5887
- * - **ThreadSafety**: Unsafe
5888
- *
5889
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#NetSync)
5890
- */
5891
- NetSync(this: AuroraService, target: Instance): void;
5892
5898
  /**
5893
5899
  * - **ThreadSafety**: Unsafe
5894
5900
  *
@@ -16182,6 +16188,12 @@ interface GuiButton extends GuiObject {
16182
16188
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#AutoButtonColor)
16183
16189
  */
16184
16190
  AutoButtonColor: boolean;
16191
+ /**
16192
+ * - **ThreadSafety**: ReadSafe
16193
+ *
16194
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#HoverHapticEffect)
16195
+ */
16196
+ HoverHapticEffect: HapticEffect | undefined;
16185
16197
  /**
16186
16198
  * If `true` while the GUI element is visible, the mouse will not be locked unless the right mouse button is down.
16187
16199
  *
@@ -16190,6 +16202,12 @@ interface GuiButton extends GuiObject {
16190
16202
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#Modal)
16191
16203
  */
16192
16204
  Modal: boolean;
16205
+ /**
16206
+ * - **ThreadSafety**: ReadSafe
16207
+ *
16208
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#PressHapticEffect)
16209
+ */
16210
+ PressHapticEffect: HapticEffect | undefined;
16193
16211
  /**
16194
16212
  * A boolean property which indicates whether the object has been selected.
16195
16213
  *
@@ -19652,6 +19670,8 @@ interface GuiService extends Instance {
19652
19670
  readonly MenuOpened: RBXScriptSignal<() => void>;
19653
19671
  }
19654
19672
  /**
19673
+ * - **Tags**: NotBrowsable
19674
+ *
19655
19675
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
19656
19676
  */
19657
19677
  interface HapticEffect extends Instance {
@@ -22377,6 +22397,24 @@ interface InputBinding extends Instance {
22377
22397
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
22378
22398
  */
22379
22399
  KeyCode: Enum.KeyCode;
22400
+ /**
22401
+ * - **ThreadSafety**: ReadSafe
22402
+ *
22403
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
22404
+ */
22405
+ PressedThreshold: number;
22406
+ /**
22407
+ * - **ThreadSafety**: ReadSafe
22408
+ *
22409
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
22410
+ */
22411
+ ReleasedThreshold: number;
22412
+ /**
22413
+ * - **ThreadSafety**: ReadSafe
22414
+ *
22415
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
22416
+ */
22417
+ Scale: number;
22380
22418
  /**
22381
22419
  * - **ThreadSafety**: ReadSafe
22382
22420
  *
@@ -24937,18 +24975,25 @@ interface MatchmakingService extends Instance {
24937
24975
  * - **ThreadSafety**: Unsafe
24938
24976
  *
24939
24977
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#GetServerAttribute)
24978
+ * @param this
24979
+ * @param name
24940
24980
  */
24941
24981
  GetServerAttribute(this: MatchmakingService, name: string): unknown;
24942
24982
  /**
24943
24983
  * - **ThreadSafety**: Unsafe
24944
24984
  *
24945
24985
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#InitializeServerAttributesForStudio)
24986
+ * @param this
24987
+ * @param serverAttributes
24946
24988
  */
24947
24989
  InitializeServerAttributesForStudio(this: MatchmakingService, serverAttributes: object): unknown;
24948
24990
  /**
24949
24991
  * - **ThreadSafety**: Unsafe
24950
24992
  *
24951
24993
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#SetServerAttribute)
24994
+ * @param this
24995
+ * @param name
24996
+ * @param value
24952
24997
  */
24953
24998
  SetServerAttribute(this: MatchmakingService, name: string, value: unknown): unknown;
24954
24999
  }
@@ -31277,12 +31322,6 @@ interface PlayerDataRecord extends Instance {
31277
31322
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#GetValueChangedSignal)
31278
31323
  */
31279
31324
  GetValueChangedSignal(this: PlayerDataRecord, key: string): RBXScriptSignal;
31280
- /**
31281
- * - **ThreadSafety**: Unsafe
31282
- *
31283
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#Release)
31284
- */
31285
- Release(this: PlayerDataRecord): void;
31286
31325
  /**
31287
31326
  * - **ThreadSafety**: Unsafe
31288
31327
  *
@@ -31295,6 +31334,13 @@ interface PlayerDataRecord extends Instance {
31295
31334
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#SetValue)
31296
31335
  */
31297
31336
  SetValue(this: PlayerDataRecord, key: string, value: unknown): void;
31337
+ /**
31338
+ * - **ThreadSafety**: Unsafe
31339
+ * - **Tags**: Yields
31340
+ *
31341
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerDataRecord#ReleaseAsync)
31342
+ */
31343
+ ReleaseAsync(this: PlayerDataRecord): void;
31298
31344
  /**
31299
31345
  * - **ThreadSafety**: Unsafe
31300
31346
  * - **Tags**: Yields
@@ -33927,6 +33973,8 @@ interface DataModel extends ServiceProvider<Services> {
33927
33973
  */
33928
33974
  readonly JobId: string;
33929
33975
  /**
33976
+ * Represents how players in the server are handled by matchmaking.
33977
+ *
33930
33978
  * - **ThreadSafety**: ReadSafe
33931
33979
  * - **Tags**: NotReplicated
33932
33980
  *
@@ -34507,6 +34555,12 @@ interface SocialService extends Instance {
34507
34555
  * @deprecated
34508
34556
  */
34509
34557
  readonly _nominal_SocialService: unique symbol;
34558
+ /**
34559
+ * - **ThreadSafety**: Unsafe
34560
+ *
34561
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId)
34562
+ */
34563
+ GetPlayersByPartyId(this: SocialService, partyId: string): Array<Instance>;
34510
34564
  /**
34511
34565
  * Hides the calling player's self view.
34512
34566
  *
@@ -36370,7 +36424,7 @@ interface StyleBase extends Instance {
36370
36424
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleBase#InsertStyleRule)
36371
36425
  * @param this
36372
36426
  * @param rule
36373
- * @param index
36427
+ * @param priority
36374
36428
  */
36375
36429
  InsertStyleRule(this: StyleBase, rule: StyleRule, priority?: number): void;
36376
36430
  /**
@@ -36439,7 +36493,7 @@ interface StyleRule extends StyleBase {
36439
36493
  *
36440
36494
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetProperties)
36441
36495
  * @param this
36442
- * @param table
36496
+ * @param styleProperties
36443
36497
  */
36444
36498
  SetProperties(this: StyleRule, styleProperties: object): void;
36445
36499
  /**
@@ -42494,6 +42548,79 @@ interface VoiceChatService extends Instance {
42494
42548
  */
42495
42549
  IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: number): boolean;
42496
42550
  }
42551
+ /**
42552
+ * - **Tags**: NotCreatable, NotReplicated
42553
+ *
42554
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient)
42555
+ */
42556
+ interface WebSocketClient extends Instance {
42557
+ /**
42558
+ * **DO NOT USE!**
42559
+ *
42560
+ * This field exists to force TypeScript to recognize this as a nominal type
42561
+ * @hidden
42562
+ * @deprecated
42563
+ */
42564
+ readonly _nominal_WebSocketClient: unique symbol;
42565
+ /**
42566
+ * - **ThreadSafety**: ReadSafe
42567
+ * - **Tags**: NotReplicated
42568
+ *
42569
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#ConnectionState)
42570
+ */
42571
+ readonly ConnectionState: Enum.WebSocketState;
42572
+ /**
42573
+ * - **ThreadSafety**: Unsafe
42574
+ *
42575
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
42576
+ */
42577
+ Close(this: WebSocketClient): void;
42578
+ /**
42579
+ * - **ThreadSafety**: Unsafe
42580
+ *
42581
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
42582
+ */
42583
+ Send(this: WebSocketClient, data: string): void;
42584
+ /**
42585
+ * - **ThreadSafety**: Unsafe
42586
+ *
42587
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Closed)
42588
+ */
42589
+ readonly Closed: RBXScriptSignal<() => void>;
42590
+ /**
42591
+ * - **ThreadSafety**: Unsafe
42592
+ *
42593
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#MessageReceived)
42594
+ */
42595
+ readonly MessageReceived: RBXScriptSignal<(data: string) => void>;
42596
+ /**
42597
+ * - **ThreadSafety**: Unsafe
42598
+ *
42599
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Opened)
42600
+ */
42601
+ readonly Opened: RBXScriptSignal<() => void>;
42602
+ }
42603
+ /**
42604
+ * - **Tags**: NotCreatable, Service, NotReplicated
42605
+ *
42606
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService)
42607
+ */
42608
+ interface WebSocketService extends Instance {
42609
+ /**
42610
+ * **DO NOT USE!**
42611
+ *
42612
+ * This field exists to force TypeScript to recognize this as a nominal type
42613
+ * @hidden
42614
+ * @deprecated
42615
+ */
42616
+ readonly _nominal_WebSocketService: unique symbol;
42617
+ /**
42618
+ * - **ThreadSafety**: Unsafe
42619
+ *
42620
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
42621
+ */
42622
+ CreateClient(this: WebSocketService, uri: string): WebSocketClient;
42623
+ }
42497
42624
  /**
42498
42625
  * - **Tags**: NotCreatable, Service, NotReplicated
42499
42626
  *
@@ -224,6 +224,7 @@ interface Services {
224
224
  VoiceChatService: VoiceChatService;
225
225
  VRService: VRService;
226
226
  VRStatusService: VRStatusService;
227
+ WebSocketService: WebSocketService;
227
228
  WebViewService: WebViewService;
228
229
  Workspace: Workspace;
229
230
  }
@@ -716,6 +717,7 @@ interface Instances extends Services, CreatableInstances {
716
717
  UserGameSettings: UserGameSettings;
717
718
  UserSettings: UserSettings;
718
719
  ValueBase: ValueBase;
720
+ WebSocketClient: WebSocketClient;
719
721
  WorldRoot: WorldRoot;
720
722
  }
721
723
  interface Objects extends Instances {
@@ -1763,6 +1765,8 @@ interface AudioSearchParams extends Instance {
1763
1765
  readonly _nominal_AudioSearchParams: unique symbol;
1764
1766
  }
1765
1767
  /**
1768
+ * - **Tags**: NotBrowsable
1769
+ *
1766
1770
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
1767
1771
  */
1768
1772
  interface AudioTextToSpeech extends Instance {
@@ -6301,6 +6305,8 @@ interface GuiService extends Instance {
6301
6305
  readonly _nominal_GuiService: unique symbol;
6302
6306
  }
6303
6307
  /**
6308
+ * - **Tags**: NotBrowsable
6309
+ *
6304
6310
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
6305
6311
  */
6306
6312
  interface HapticEffect extends Instance {
@@ -11959,6 +11965,8 @@ interface SoundService extends Instance {
11959
11965
  */
11960
11966
  set CharacterSoundsUseNewApi(value: Enum.RolloutState);
11961
11967
  /**
11968
+ * Determines where (if anywhere) to place an `AudioListener` by default.
11969
+ *
11962
11970
  * - **ThreadSafety**: ReadSafe
11963
11971
  *
11964
11972
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DefaultListenerLocation)
@@ -14378,6 +14386,36 @@ interface VoiceChatService extends Instance {
14378
14386
  */
14379
14387
  UseAudioApi: Enum.AudioApiRollout;
14380
14388
  }
14389
+ /**
14390
+ * - **Tags**: NotCreatable, NotReplicated
14391
+ *
14392
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient)
14393
+ */
14394
+ interface WebSocketClient extends Instance {
14395
+ /**
14396
+ * **DO NOT USE!**
14397
+ *
14398
+ * This field exists to force TypeScript to recognize this as a nominal type
14399
+ * @hidden
14400
+ * @deprecated
14401
+ */
14402
+ readonly _nominal_WebSocketClient: unique symbol;
14403
+ }
14404
+ /**
14405
+ * - **Tags**: NotCreatable, Service, NotReplicated
14406
+ *
14407
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService)
14408
+ */
14409
+ interface WebSocketService extends Instance {
14410
+ /**
14411
+ * **DO NOT USE!**
14412
+ *
14413
+ * This field exists to force TypeScript to recognize this as a nominal type
14414
+ * @hidden
14415
+ * @deprecated
14416
+ */
14417
+ readonly _nominal_WebSocketService: unique symbol;
14418
+ }
14381
14419
  /**
14382
14420
  * - **Tags**: NotCreatable, Service, NotReplicated
14383
14421
  *
@@ -981,11 +981,20 @@ declare namespace Enum {
981
981
  EnumType: typeof globalThis.Enum.AlphaMode;
982
982
  }
983
983
  export const Transparency: Transparency;
984
+ /**
985
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AlphaMode#TintMask)
986
+ */
987
+ export interface TintMask extends globalThis.EnumItem {
988
+ Name: "TintMask";
989
+ Value: 2;
990
+ EnumType: typeof globalThis.Enum.AlphaMode;
991
+ }
992
+ export const TintMask: TintMask;
984
993
  export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AlphaMode>;
985
994
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AlphaMode | undefined;
986
995
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AlphaMode | undefined;
987
996
  }
988
- export type AlphaMode = AlphaMode.Overlay | AlphaMode.Transparency;
997
+ export type AlphaMode = AlphaMode.Overlay | AlphaMode.Transparency | AlphaMode.TintMask;
989
998
  /**
990
999
  * Used to form a dictionary of custom fields to provide breakdowns in Roblox-provided charts.
991
1000
  *
@@ -5121,42 +5130,6 @@ declare namespace Enum {
5121
5130
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CameraType | undefined;
5122
5131
  }
5123
5132
  export type CameraType = CameraType.Fixed | CameraType.Attach | CameraType.Watch | CameraType.Track | CameraType.Follow | CameraType.Custom | CameraType.Scriptable | CameraType.Orbital;
5124
- /**
5125
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode)
5126
- */
5127
- export namespace CaptureUIHideMode {
5128
- /**
5129
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#All)
5130
- */
5131
- export interface All extends globalThis.EnumItem {
5132
- Name: "All";
5133
- Value: 0;
5134
- EnumType: typeof globalThis.Enum.CaptureUIHideMode;
5135
- }
5136
- export const All: All;
5137
- /**
5138
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#None)
5139
- */
5140
- export interface None extends globalThis.EnumItem {
5141
- Name: "None";
5142
- Value: 1;
5143
- EnumType: typeof globalThis.Enum.CaptureUIHideMode;
5144
- }
5145
- export const None: None;
5146
- /**
5147
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureUIHideMode#Core)
5148
- */
5149
- export interface Core extends globalThis.EnumItem {
5150
- Name: "Core";
5151
- Value: 2;
5152
- EnumType: typeof globalThis.Enum.CaptureUIHideMode;
5153
- }
5154
- export const Core: Core;
5155
- export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CaptureUIHideMode>;
5156
- export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CaptureUIHideMode | undefined;
5157
- export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CaptureUIHideMode | undefined;
5158
- }
5159
- export type CaptureUIHideMode = CaptureUIHideMode.All | CaptureUIHideMode.None | CaptureUIHideMode.Core;
5160
5133
  /**
5161
5134
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter)
5162
5135
  */
@@ -17704,11 +17677,13 @@ declare namespace Enum {
17704
17677
  }
17705
17678
  export type ListDisplayMode = ListDisplayMode.Horizontal | ListDisplayMode.Vertical;
17706
17679
  /**
17680
+ * Enum used with `SoundService.DefaultListenerLocation` to determine where an `AudioListener` is placed by default.
17681
+ *
17707
17682
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation)
17708
17683
  */
17709
17684
  export namespace ListenerLocation {
17710
17685
  /**
17711
- * An `AudioListener` will be created and parented to `Workspace.CurrentCamera` in experiences that enable voice chat.
17686
+ * Behavior depends on the value of `VoiceChatService.EnableDefaultVoice` and `VoiceChatService.UseAudioApi`. When using the default voice setup with the audio API, this behaves similarly to `Camera`.
17712
17687
  *
17713
17688
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Default)
17714
17689
  */
@@ -17719,7 +17694,7 @@ declare namespace Enum {
17719
17694
  }
17720
17695
  export const Default: Default;
17721
17696
  /**
17722
- * No `AudioListeners` will be spawned by default.
17697
+ * No `AudioListener` will be created by default, but they can be created separately by scripts.
17723
17698
  *
17724
17699
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#None)
17725
17700
  */
@@ -17730,7 +17705,13 @@ declare namespace Enum {
17730
17705
  }
17731
17706
  export const None: None;
17732
17707
  /**
17733
- * An `AudioListener` will be created and attached to the local player's `Player.Character`.
17708
+ * All of the following, resulting in the world being heard from the position of your character while matching the orientation of your camera. - An `Attachment` will be created and parented to the `PrimaryPart` of the local player's `Character` model.
17709
+ * - An `AudioListener` will be created and parented to the `Attachment`.
17710
+ * - An `AudioDeviceOutput` will be created and parented to `SoundService`.
17711
+ * - A `Wire` will be created and parented to the previously-created `AudioListener`. The wire's `SourceInstance` will be set to the previously-created `AudioListener` and its `TargetInstance` will be set to the previously-created `AudioDeviceOutput`.
17712
+ * - The previously-created `Attachment` will be updated once per frame to face the same direction as `Workspace.CurrentCamera`.
17713
+ *
17714
+ *
17734
17715
  *
17735
17716
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Character)
17736
17717
  */
@@ -17741,7 +17722,11 @@ declare namespace Enum {
17741
17722
  }
17742
17723
  export const Character: Character;
17743
17724
  /**
17744
- * An `AudioListener` will be created and parented to `Workspace.CurrentCamera`.
17725
+ * All of the following, resulting in the world being heard from the perspective (postition and orientation) of the camera. - An `AudioListener` will be created and parented to `Workspace.CurrentCamera`.
17726
+ * - An `AudioDeviceOutput` will be created and parented to `SoundService`.
17727
+ * - A `Wire` will be created and parented to the previously-created `AudioListener`. The wire's `SourceInstance` will be set to the previously-created `AudioListener` and its `TargetInstance` will be set to the previously-created `AudioDeviceOutput`.
17728
+ *
17729
+ *
17745
17730
  *
17746
17731
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Camera)
17747
17732
  */
@@ -18267,10 +18252,14 @@ declare namespace Enum {
18267
18252
  }
18268
18253
  export type MarkupKind = MarkupKind.PlainText | MarkupKind.Markdown;
18269
18254
  /**
18255
+ * Used with `DataModel.MatchmakingType` to represent how players in the server are handled by matchmaking.
18256
+ *
18270
18257
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType)
18271
18258
  */
18272
18259
  export namespace MatchmakingType {
18273
18260
  /**
18261
+ * Includes desktop, mobile, cross-play enabled players, etc.
18262
+ *
18274
18263
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#Default)
18275
18264
  */
18276
18265
  export interface Default extends globalThis.EnumItem {
@@ -18280,6 +18269,8 @@ declare namespace Enum {
18280
18269
  }
18281
18270
  export const Default: Default;
18282
18271
  /**
18272
+ * Xbox players with cross-play disabled.
18273
+ *
18283
18274
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#XboxOnly)
18284
18275
  */
18285
18276
  export interface XboxOnly extends globalThis.EnumItem {
@@ -18289,6 +18280,8 @@ declare namespace Enum {
18289
18280
  }
18290
18281
  export const XboxOnly: XboxOnly;
18291
18282
  /**
18283
+ * PlayStation players with cross-play disabled.
18284
+ *
18292
18285
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#PlayStationOnly)
18293
18286
  */
18294
18287
  export interface PlayStationOnly extends globalThis.EnumItem {
@@ -21460,12 +21453,21 @@ declare namespace Enum {
21460
21453
  EnumType: typeof globalThis.Enum.PlayerDataErrorState;
21461
21454
  }
21462
21455
  export const FlushFailed: FlushFailed;
21456
+ /**
21457
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#ReleaseFailed)
21458
+ */
21459
+ export interface ReleaseFailed extends globalThis.EnumItem {
21460
+ Name: "ReleaseFailed";
21461
+ Value: 2;
21462
+ EnumType: typeof globalThis.Enum.PlayerDataErrorState;
21463
+ }
21464
+ export const ReleaseFailed: ReleaseFailed;
21463
21465
  /**
21464
21466
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#None)
21465
21467
  */
21466
21468
  export interface None extends globalThis.EnumItem {
21467
21469
  Name: "None";
21468
- Value: 2;
21470
+ Value: 3;
21469
21471
  EnumType: typeof globalThis.Enum.PlayerDataErrorState;
21470
21472
  }
21471
21473
  export const None: None;
@@ -21473,7 +21475,7 @@ declare namespace Enum {
21473
21475
  export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.PlayerDataErrorState | undefined;
21474
21476
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.PlayerDataErrorState | undefined;
21475
21477
  }
21476
- export type PlayerDataErrorState = PlayerDataErrorState.LoadFailed | PlayerDataErrorState.FlushFailed | PlayerDataErrorState.None;
21478
+ export type PlayerDataErrorState = PlayerDataErrorState.LoadFailed | PlayerDataErrorState.FlushFailed | PlayerDataErrorState.ReleaseFailed | PlayerDataErrorState.None;
21477
21479
  /**
21478
21480
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior)
21479
21481
  */
@@ -25550,6 +25552,87 @@ declare namespace Enum {
25550
25552
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StartCorner | undefined;
25551
25553
  }
25552
25554
  export type StartCorner = StartCorner.TopLeft | StartCorner.TopRight | StartCorner.BottomLeft | StartCorner.BottomRight;
25555
+ /**
25556
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType)
25557
+ */
25558
+ export namespace StateObjectFieldType {
25559
+ /**
25560
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Boolean)
25561
+ */
25562
+ export interface Boolean extends globalThis.EnumItem {
25563
+ Name: "Boolean";
25564
+ Value: 0;
25565
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25566
+ }
25567
+ export const Boolean: Boolean;
25568
+ /**
25569
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#CFrame)
25570
+ */
25571
+ export interface CFrame extends globalThis.EnumItem {
25572
+ Name: "CFrame";
25573
+ Value: 1;
25574
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25575
+ }
25576
+ export const CFrame: CFrame;
25577
+ /**
25578
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Float)
25579
+ */
25580
+ export interface Float extends globalThis.EnumItem {
25581
+ Name: "Float";
25582
+ Value: 2;
25583
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25584
+ }
25585
+ export const Float: Float;
25586
+ /**
25587
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Instance)
25588
+ */
25589
+ export interface Instance extends globalThis.EnumItem {
25590
+ Name: "Instance";
25591
+ Value: 3;
25592
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25593
+ }
25594
+ export const Instance: Instance;
25595
+ /**
25596
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Random)
25597
+ */
25598
+ export interface Random extends globalThis.EnumItem {
25599
+ Name: "Random";
25600
+ Value: 4;
25601
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25602
+ }
25603
+ export const Random: Random;
25604
+ /**
25605
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector2)
25606
+ */
25607
+ export interface Vector2 extends globalThis.EnumItem {
25608
+ Name: "Vector2";
25609
+ Value: 5;
25610
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25611
+ }
25612
+ export const Vector2: Vector2;
25613
+ /**
25614
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector3)
25615
+ */
25616
+ export interface Vector3 extends globalThis.EnumItem {
25617
+ Name: "Vector3";
25618
+ Value: 6;
25619
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25620
+ }
25621
+ export const Vector3: Vector3;
25622
+ /**
25623
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#INVALID)
25624
+ */
25625
+ export interface INVALID extends globalThis.EnumItem {
25626
+ Name: "INVALID";
25627
+ Value: 7;
25628
+ EnumType: typeof globalThis.Enum.StateObjectFieldType;
25629
+ }
25630
+ export const INVALID: INVALID;
25631
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.StateObjectFieldType>;
25632
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.StateObjectFieldType | undefined;
25633
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StateObjectFieldType | undefined;
25634
+ }
25635
+ export type StateObjectFieldType = StateObjectFieldType.Boolean | StateObjectFieldType.CFrame | StateObjectFieldType.Float | StateObjectFieldType.Instance | StateObjectFieldType.Random | StateObjectFieldType.Vector2 | StateObjectFieldType.Vector3 | StateObjectFieldType.INVALID;
25553
25636
  /**
25554
25637
  * **Deprecated:** This enum is deprecated as it was only used by deprecated methods and events. It should not be used in new work.
25555
25638
  *
@@ -30265,6 +30348,42 @@ declare namespace Enum {
30265
30348
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.TweenStatus | undefined;
30266
30349
  }
30267
30350
  export type TweenStatus = TweenStatus.Canceled | TweenStatus.Completed;
30351
+ /**
30352
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode)
30353
+ */
30354
+ export namespace UICaptureMode {
30355
+ /**
30356
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#All)
30357
+ */
30358
+ export interface All extends globalThis.EnumItem {
30359
+ Name: "All";
30360
+ Value: 0;
30361
+ EnumType: typeof globalThis.Enum.UICaptureMode;
30362
+ }
30363
+ export const All: All;
30364
+ /**
30365
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#None)
30366
+ */
30367
+ export interface None extends globalThis.EnumItem {
30368
+ Name: "None";
30369
+ Value: 1;
30370
+ EnumType: typeof globalThis.Enum.UICaptureMode;
30371
+ }
30372
+ export const None: None;
30373
+ /**
30374
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#PlayerGui)
30375
+ */
30376
+ export interface PlayerGui extends globalThis.EnumItem {
30377
+ Name: "PlayerGui";
30378
+ Value: 2;
30379
+ EnumType: typeof globalThis.Enum.UICaptureMode;
30380
+ }
30381
+ export const PlayerGui: PlayerGui;
30382
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.UICaptureMode>;
30383
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.UICaptureMode | undefined;
30384
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.UICaptureMode | undefined;
30385
+ }
30386
+ export type UICaptureMode = UICaptureMode.All | UICaptureMode.None | UICaptureMode.PlayerGui;
30268
30387
  /**
30269
30388
  * Used with `UIDragDetector` to determine bounding behavior of the dragged UI object when `UIDragDetector.BoundingUI` is set.
30270
30389
  *
@@ -32309,6 +32428,51 @@ declare namespace Enum {
32309
32428
  export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.WaterForce | undefined;
32310
32429
  }
32311
32430
  export type WaterForce = WaterForce.None | WaterForce.Small | WaterForce.Medium | WaterForce.Strong | WaterForce.Max;
32431
+ /**
32432
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState)
32433
+ */
32434
+ export namespace WebSocketState {
32435
+ /**
32436
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Connecting)
32437
+ */
32438
+ export interface Connecting extends globalThis.EnumItem {
32439
+ Name: "Connecting";
32440
+ Value: 0;
32441
+ EnumType: typeof globalThis.Enum.WebSocketState;
32442
+ }
32443
+ export const Connecting: Connecting;
32444
+ /**
32445
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Open)
32446
+ */
32447
+ export interface Open extends globalThis.EnumItem {
32448
+ Name: "Open";
32449
+ Value: 1;
32450
+ EnumType: typeof globalThis.Enum.WebSocketState;
32451
+ }
32452
+ export const Open: Open;
32453
+ /**
32454
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closing)
32455
+ */
32456
+ export interface Closing extends globalThis.EnumItem {
32457
+ Name: "Closing";
32458
+ Value: 2;
32459
+ EnumType: typeof globalThis.Enum.WebSocketState;
32460
+ }
32461
+ export const Closing: Closing;
32462
+ /**
32463
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closed)
32464
+ */
32465
+ export interface Closed extends globalThis.EnumItem {
32466
+ Name: "Closed";
32467
+ Value: 3;
32468
+ EnumType: typeof globalThis.Enum.WebSocketState;
32469
+ }
32470
+ export const Closed: Closed;
32471
+ export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.WebSocketState>;
32472
+ export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.WebSocketState | undefined;
32473
+ export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.WebSocketState | undefined;
32474
+ }
32475
+ export type WebSocketState = WebSocketState.Connecting | WebSocketState.Open | WebSocketState.Closing | WebSocketState.Closed;
32312
32476
  /**
32313
32477
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve)
32314
32478
  */
@@ -47,6 +47,7 @@ interface UserInfo {
47
47
  Id: number;
48
48
  Username: string;
49
49
  DisplayName: string;
50
+ HasVerifiedBadge: boolean;
50
51
  }
51
52
 
52
53
  interface GroupInfo {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.841",
3
+ "version": "1.0.843",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },