@rbxts/types 1.0.634 → 1.0.637

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.
@@ -403,6 +403,7 @@ interface AbstractInstances {
403
403
  }
404
404
 
405
405
  interface Instances extends Services, CreatableInstances, AbstractInstances {
406
+ AdGui: AdGui;
406
407
  AnimationClip: AnimationClip;
407
408
  AnimationStreamTrack: AnimationStreamTrack;
408
409
  AnimationTrack: AnimationTrack;
@@ -472,6 +473,7 @@ interface Instances extends Services, CreatableInstances, AbstractInstances {
472
473
  StandardPages: StandardPages;
473
474
  StarterCharacterScripts: StarterCharacterScripts;
474
475
  StarterPlayerScripts: StarterPlayerScripts;
476
+ SurfaceGuiBase: SurfaceGuiBase;
475
477
  TeleportAsyncResult: TeleportAsyncResult;
476
478
  Terrain: Terrain;
477
479
  TextChatConfigurations: TextChatConfigurations;
@@ -2052,8 +2054,6 @@ interface AssetImportService extends Instance {
2052
2054
  * @deprecated
2053
2055
  */
2054
2056
  readonly _nominal_AssetImportService: unique symbol;
2055
- readonly ProgressUpdate: RBXScriptSignal<(progressRatio: number) => void>;
2056
- readonly UploadFinished: RBXScriptSignal<(succeeded: boolean, errorMap: object) => void>;
2057
2057
  }
2058
2058
 
2059
2059
  interface AssetImportSession extends Instance {
@@ -10496,7 +10496,7 @@ interface DataStore extends GlobalDataStore {
10496
10496
  ): R extends undefined
10497
10497
  ? LuaTuple<[newValue: O | undefined, keyInfo: DataStoreKeyInfo]>
10498
10498
  : LuaTuple<[newValue: R, keyInfo: DataStoreKeyInfo]>;
10499
- RemoveAsync<T>(this: DataStore, key: string): LuaTuple<[T | undefined, DataStoreKeyInfo]>;
10499
+ RemoveAsync<T>(this: DataStore, key: string): LuaTuple<[T | undefined, DataStoreKeyInfo | undefined]>;
10500
10500
  /**
10501
10501
  * This function retrieves the specified key version as well as a [DataStoreKeyInfo](https://developer.roblox.com/en-us/api-reference/class/DataStoreKeyInfo) instance. A version identifier can be found through [DataStore:ListVersionsAsync](https://developer.roblox.com/en-us/api-reference/function/DataStore/ListVersionsAsync) or alternatively be the identifier returned by [GlobalDataStore:SetAsync](https://developer.roblox.com/en-us/api-reference/function/GlobalDataStore/SetAsync).
10502
10502
  *
@@ -10562,10 +10562,10 @@ interface OrderedDataStore extends GlobalDataStore {
10562
10562
  readonly _nominal_OrderedDataStore: unique symbol;
10563
10563
  GetAsync(this: OrderedDataStore, key: string): number | undefined;
10564
10564
  IncrementAsync(this: OrderedDataStore, key: string, delta?: number): number;
10565
- RemoveAsync(this: OrderedDataStore, key: string): number;
10566
- SetAsync(this: GlobalDataStore, key: string, value?: unknown): void;
10565
+ RemoveAsync(this: OrderedDataStore, key: string): number | undefined;
10566
+ SetAsync(this: OrderedDataStore, key: string, value?: unknown): void;
10567
10567
  UpdateAsync<O, R>(
10568
- this: GlobalDataStore,
10568
+ this: OrderedDataStore,
10569
10569
  key: string,
10570
10570
  transformFunction: (oldValue: O | undefined) => R,
10571
10571
  ): R extends undefined ? O | undefined : R;
@@ -13250,6 +13250,32 @@ interface ScreenGui extends LayerCollector {
13250
13250
  IgnoreGuiInset: boolean;
13251
13251
  }
13252
13252
 
13253
+ interface SurfaceGuiBase extends LayerCollector {
13254
+ /**
13255
+ * **DO NOT USE!**
13256
+ *
13257
+ * This field exists to force TypeScript to recognize this as a nominal type
13258
+ * @hidden
13259
+ * @deprecated
13260
+ */
13261
+ readonly _nominal_SurfaceGuiBase: unique symbol;
13262
+ Active: boolean;
13263
+ Adornee: Instance | undefined;
13264
+ Face: Enum.NormalId;
13265
+ }
13266
+
13267
+ interface AdGui extends SurfaceGuiBase {
13268
+ /**
13269
+ * **DO NOT USE!**
13270
+ *
13271
+ * This field exists to force TypeScript to recognize this as a nominal type
13272
+ * @hidden
13273
+ * @deprecated
13274
+ */
13275
+ readonly _nominal_AdGui: unique symbol;
13276
+ AdShape: Enum.AdShape;
13277
+ }
13278
+
13253
13279
  /** **Note:** SurfaceGuis must be descendants of PlayerGui in order to know the player who is interacting with it.Allows for the rendering of GUI elements onto a part's surface in the 3D world, whilst allowing for basic user interaction to occur.
13254
13280
  *
13255
13281
  * ##### Caching static UI for performance improvements
@@ -13270,13 +13296,6 @@ interface SurfaceGui extends LayerCollector {
13270
13296
  * @deprecated
13271
13297
  */
13272
13298
  readonly _nominal_SurfaceGui: unique symbol;
13273
- /**
13274
- * Whether or not mouse events will be passed to objects layered below.
13275
- */
13276
- Active: boolean;
13277
- /**
13278
- * Sets the object that the SurfaceGui is adorned too. In other words, this defines which [BasePart](https://developer.roblox.com/en-us/api-reference/class/BasePart) the SurfaceGui is attached to.
13279
- */
13280
13299
  Adornee: BasePart | undefined;
13281
13300
  /**
13282
13301
  * Determines whether the SurfaceGui will render over top of 3D content, or
@@ -13317,10 +13336,6 @@ interface SurfaceGui extends LayerCollector {
13317
13336
  * the canvas of the SurfaceGui will not render.
13318
13337
  */
13319
13338
  ClipsDescendants: boolean;
13320
- /**
13321
- * The face that the SurfaceGui is rendered on.
13322
- */
13323
- Face: Enum.NormalId;
13324
13339
  /**
13325
13340
  * Controls how much the SurfaceGui is influenced by the lighting in the game world.
13326
13341
  */
@@ -16335,26 +16350,14 @@ interface ImporterMaterialSettings extends ImporterBaseSettings {
16335
16350
  * @deprecated
16336
16351
  */
16337
16352
  readonly _nominal_ImporterMaterialSettings: unique symbol;
16338
- /**
16339
- * Tags: ReadOnly, NotReplicated
16340
- */
16341
- readonly DiffuseFilePath: string;
16353
+ DiffuseFilePath: string;
16342
16354
  /**
16343
16355
  * Tags: ReadOnly, NotReplicated
16344
16356
  */
16345
16357
  readonly IsPbr: boolean;
16346
- /**
16347
- * Tags: ReadOnly, NotReplicated
16348
- */
16349
- readonly MetalnessFilePath: string;
16350
- /**
16351
- * Tags: ReadOnly, NotReplicated
16352
- */
16353
- readonly NormalFilePath: string;
16354
- /**
16355
- * Tags: ReadOnly, NotReplicated
16356
- */
16357
- readonly RoughnessFilePath: string;
16358
+ MetalnessFilePath: string;
16359
+ NormalFilePath: string;
16360
+ RoughnessFilePath: string;
16358
16361
  }
16359
16362
 
16360
16363
  interface ImporterMeshSettings extends ImporterBaseSettings {
@@ -16403,6 +16406,11 @@ interface ImporterMeshSettings extends ImporterBaseSettings {
16403
16406
  * Tags: ReadOnly, NotReplicated
16404
16407
  */
16405
16408
  readonly NoIrrelevantCageModified: boolean;
16409
+ /**
16410
+ * Tags: ReadOnly, NotReplicated
16411
+ */
16412
+ readonly NoOuterCageFarExtendedFromMesh: boolean;
16413
+ OuterCageFarExtendedFromMeshPreview: boolean;
16406
16414
  /**
16407
16415
  * Tags: ReadOnly, NotReplicated
16408
16416
  */
@@ -21434,7 +21442,12 @@ interface MemoryStoreQueue extends Instance {
21434
21442
  * This method does not automatically delete the returned items from the queue but makes them invisible to other ReadAsync calls for the period of the invisibility timeout. The items must be explicitly removed from the queue with [MemoryStoreQueue:RemoveAsync](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreQueue/RemoveAsync) before the invisibility timeout expires. The invisibility timeout defaults to 30 seconds unless a different value was provided in [MemoryStoreService:GetQueue](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreService/GetQueue).
21435
21443
  * Tags: Yields
21436
21444
  */
21437
- ReadAsync(this: MemoryStoreQueue, count: number, allOrNothing?: boolean, waitTimeout?: number): unknown;
21445
+ ReadAsync(
21446
+ this: MemoryStoreQueue,
21447
+ count: number,
21448
+ allOrNothing?: boolean,
21449
+ waitTimeout?: number,
21450
+ ): LuaTuple<[items: Array<unknown>, id: string]>;
21438
21451
  /**
21439
21452
  * Removes an item or items previously read from the queue. This method uses the identifier returned by [MemoryStoreQueue:ReadAsync](https://developer.roblox.com/en-us/api-reference/function/MemoryStoreQueue/ReadAsync) to identify the items to remove. If called after the invisibility timeout has expired, the call has no effect.
21440
21453
  * Tags: Yields
@@ -31841,6 +31854,14 @@ interface ChatInputBarConfiguration extends TextChatConfigurations {
31841
31854
  * @deprecated
31842
31855
  */
31843
31856
  readonly _nominal_ChatInputBarConfiguration: unique symbol;
31857
+ /**
31858
+ * Tags: ReadOnly, NotReplicated
31859
+ */
31860
+ readonly AbsolutePosition: Vector2;
31861
+ /**
31862
+ * Tags: ReadOnly, NotReplicated
31863
+ */
31864
+ readonly AbsoluteSize: Vector2;
31844
31865
  Enabled: boolean;
31845
31866
  TargetTextChannel: TextChannel | undefined;
31846
31867
  }
@@ -31854,6 +31875,14 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
31854
31875
  * @deprecated
31855
31876
  */
31856
31877
  readonly _nominal_ChatWindowConfiguration: unique symbol;
31878
+ /**
31879
+ * Tags: ReadOnly, NotReplicated
31880
+ */
31881
+ readonly AbsolutePosition: Vector2;
31882
+ /**
31883
+ * Tags: ReadOnly, NotReplicated
31884
+ */
31885
+ readonly AbsoluteSize: Vector2;
31857
31886
  Enabled: boolean;
31858
31887
  }
31859
31888
 
@@ -2699,6 +2699,14 @@ interface ScriptDocument extends Instance {
2699
2699
  * Tags: Yields
2700
2700
  */
2701
2701
  EditTextAsync(this: ScriptDocument, newText: string, startLine: number, startCharacter: number, endLine: number, endCharacter: number): unknown;
2702
+ /**
2703
+ * Tags: Yields
2704
+ */
2705
+ ForceSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number | undefined, anchorCharacter?: number | undefined): unknown;
2706
+ /**
2707
+ * Tags: Yields
2708
+ */
2709
+ RequestSetSelectionAsync(this: ScriptDocument, cursorLine: number, cursorCharacter: number, anchorLine?: number | undefined, anchorCharacter?: number | undefined): unknown;
2702
2710
  readonly SelectionChanged: RBXScriptSignal<(positionLine: number, positionCharacter: number, anchorLine: number, anchorCharacter: number) => void>;
2703
2711
  }
2704
2712
 
@@ -9364,7 +9364,7 @@ declare namespace Enum {
9364
9364
 
9365
9365
  export interface TextDocument_publishDiagnostics extends EnumItem {
9366
9366
  Name: "TextDocument_publishDiagnostics";
9367
- Value: 19;
9367
+ Value: 20;
9368
9368
  EnumType: typeof LSPMethodType;
9369
9369
  }
9370
9370
 
@@ -9372,7 +9372,7 @@ declare namespace Enum {
9372
9372
 
9373
9373
  export interface Window_showMessage extends EnumItem {
9374
9374
  Name: "Window_showMessage";
9375
- Value: 20;
9375
+ Value: 21;
9376
9376
  EnumType: typeof LSPMethodType;
9377
9377
  }
9378
9378
 
@@ -9380,7 +9380,7 @@ declare namespace Enum {
9380
9380
 
9381
9381
  export interface Window_showMessageRequest extends EnumItem {
9382
9382
  Name: "Window_showMessageRequest";
9383
- Value: 21;
9383
+ Value: 22;
9384
9384
  EnumType: typeof LSPMethodType;
9385
9385
  }
9386
9386
 
@@ -9388,7 +9388,7 @@ declare namespace Enum {
9388
9388
 
9389
9389
  export interface Roblox_registerSyntaxCategories extends EnumItem {
9390
9390
  Name: "Roblox_registerSyntaxCategories";
9391
- Value: 22;
9391
+ Value: 23;
9392
9392
  EnumType: typeof LSPMethodType;
9393
9393
  }
9394
9394
 
@@ -9396,7 +9396,7 @@ declare namespace Enum {
9396
9396
 
9397
9397
  export interface Roblox_signalQuiescence extends EnumItem {
9398
9398
  Name: "Roblox_signalQuiescence";
9399
- Value: 23;
9399
+ Value: 24;
9400
9400
  EnumType: typeof LSPMethodType;
9401
9401
  }
9402
9402
 
@@ -9404,7 +9404,7 @@ declare namespace Enum {
9404
9404
 
9405
9405
  export interface Roblox_syntaxHighlight extends EnumItem {
9406
9406
  Name: "Roblox_syntaxHighlight";
9407
- Value: 24;
9407
+ Value: 25;
9408
9408
  EnumType: typeof LSPMethodType;
9409
9409
  }
9410
9410
 
@@ -9412,7 +9412,7 @@ declare namespace Enum {
9412
9412
 
9413
9413
  export interface Roblox_suggestExtraSelections extends EnumItem {
9414
9414
  Name: "Roblox_suggestExtraSelections";
9415
- Value: 25;
9415
+ Value: 26;
9416
9416
  EnumType: typeof LSPMethodType;
9417
9417
  }
9418
9418
 
@@ -9420,7 +9420,7 @@ declare namespace Enum {
9420
9420
 
9421
9421
  export interface Roblox_findExecutablePosition extends EnumItem {
9422
9422
  Name: "Roblox_findExecutablePosition";
9423
- Value: 26;
9423
+ Value: 27;
9424
9424
  EnumType: typeof LSPMethodType;
9425
9425
  }
9426
9426
 
@@ -9428,7 +9428,7 @@ declare namespace Enum {
9428
9428
 
9429
9429
  export interface Roblox_findColor3 extends EnumItem {
9430
9430
  Name: "Roblox_findColor3";
9431
- Value: 27;
9431
+ Value: 28;
9432
9432
  EnumType: typeof LSPMethodType;
9433
9433
  }
9434
9434
 
@@ -9436,7 +9436,7 @@ declare namespace Enum {
9436
9436
 
9437
9437
  export interface Roblox_patchSnippetData extends EnumItem {
9438
9438
  Name: "Roblox_patchSnippetData";
9439
- Value: 28;
9439
+ Value: 29;
9440
9440
  EnumType: typeof LSPMethodType;
9441
9441
  }
9442
9442
 
@@ -9685,6 +9685,34 @@ declare namespace Enum {
9685
9685
  export function GetEnumItems(this: Enum): Array<LoadCharacterLayeredClothing>
9686
9686
  }
9687
9687
  export type LoadCharacterLayeredClothing = LoadCharacterLayeredClothing.Default | LoadCharacterLayeredClothing.Disabled | LoadCharacterLayeredClothing.Enabled;
9688
+ export namespace LoadDynamicHeads {
9689
+ export interface Default extends EnumItem {
9690
+ Name: "Default";
9691
+ Value: 0;
9692
+ EnumType: typeof LoadDynamicHeads;
9693
+ }
9694
+
9695
+ export const Default: Default;
9696
+
9697
+ export interface Disabled extends EnumItem {
9698
+ Name: "Disabled";
9699
+ Value: 1;
9700
+ EnumType: typeof LoadDynamicHeads;
9701
+ }
9702
+
9703
+ export const Disabled: Disabled;
9704
+
9705
+ export interface Enabled extends EnumItem {
9706
+ Name: "Enabled";
9707
+ Value: 2;
9708
+ EnumType: typeof LoadDynamicHeads;
9709
+ }
9710
+
9711
+ export const Enabled: Enabled;
9712
+
9713
+ export function GetEnumItems(this: Enum): Array<LoadDynamicHeads>
9714
+ }
9715
+ export type LoadDynamicHeads = LoadDynamicHeads.Default | LoadDynamicHeads.Disabled | LoadDynamicHeads.Enabled;
9688
9716
  export namespace Material {
9689
9717
  export interface Plastic extends EnumItem {
9690
9718
  Name: "Plastic";
@@ -11951,6 +11979,8 @@ declare namespace Enum {
11951
11979
  }
11952
11980
 
11953
11981
  export const Blacklist: Blacklist;
11982
+ /** @deprecated renamed to Blacklist */
11983
+ export const Exclude: Blacklist;
11954
11984
 
11955
11985
  export interface Whitelist extends EnumItem {
11956
11986
  Name: "Whitelist";
@@ -11959,6 +11989,8 @@ declare namespace Enum {
11959
11989
  }
11960
11990
 
11961
11991
  export const Whitelist: Whitelist;
11992
+ /** @deprecated renamed to Whitelist */
11993
+ export const Include: Whitelist;
11962
11994
 
11963
11995
  export function GetEnumItems(this: Enum): Array<RaycastFilterType>
11964
11996
  }
@@ -15907,6 +15939,82 @@ declare namespace Enum {
15907
15939
  export function GetEnumItems(this: Enum): Array<TouchMovementMode>
15908
15940
  }
15909
15941
  export type TouchMovementMode = TouchMovementMode.Default | TouchMovementMode.Thumbstick | TouchMovementMode.DPad | TouchMovementMode.Thumbpad | TouchMovementMode.ClickToMove | TouchMovementMode.DynamicThumbstick;
15942
+ export namespace TrackerError {
15943
+ export interface Ok extends EnumItem {
15944
+ Name: "Ok";
15945
+ Value: 0;
15946
+ EnumType: typeof TrackerError;
15947
+ }
15948
+
15949
+ export const Ok: Ok;
15950
+
15951
+ export interface NoService extends EnumItem {
15952
+ Name: "NoService";
15953
+ Value: 1;
15954
+ EnumType: typeof TrackerError;
15955
+ }
15956
+
15957
+ export const NoService: NoService;
15958
+
15959
+ export interface InitFailed extends EnumItem {
15960
+ Name: "InitFailed";
15961
+ Value: 2;
15962
+ EnumType: typeof TrackerError;
15963
+ }
15964
+
15965
+ export const InitFailed: InitFailed;
15966
+
15967
+ export interface NoVideo extends EnumItem {
15968
+ Name: "NoVideo";
15969
+ Value: 3;
15970
+ EnumType: typeof TrackerError;
15971
+ }
15972
+
15973
+ export const NoVideo: NoVideo;
15974
+
15975
+ export interface VideoError extends EnumItem {
15976
+ Name: "VideoError";
15977
+ Value: 4;
15978
+ EnumType: typeof TrackerError;
15979
+ }
15980
+
15981
+ export const VideoError: VideoError;
15982
+
15983
+ export interface CameraPermission extends EnumItem {
15984
+ Name: "CameraPermission";
15985
+ Value: 5;
15986
+ EnumType: typeof TrackerError;
15987
+ }
15988
+
15989
+ export const CameraPermission: CameraPermission;
15990
+
15991
+ export interface NoAudio extends EnumItem {
15992
+ Name: "NoAudio";
15993
+ Value: 6;
15994
+ EnumType: typeof TrackerError;
15995
+ }
15996
+
15997
+ export const NoAudio: NoAudio;
15998
+
15999
+ export interface AudioError extends EnumItem {
16000
+ Name: "AudioError";
16001
+ Value: 7;
16002
+ EnumType: typeof TrackerError;
16003
+ }
16004
+
16005
+ export const AudioError: AudioError;
16006
+
16007
+ export interface MicPermission extends EnumItem {
16008
+ Name: "MicPermission";
16009
+ Value: 8;
16010
+ EnumType: typeof TrackerError;
16011
+ }
16012
+
16013
+ export const MicPermission: MicPermission;
16014
+
16015
+ export function GetEnumItems(this: Enum): Array<TrackerError>
16016
+ }
16017
+ export type TrackerError = TrackerError.Ok | TrackerError.NoService | TrackerError.InitFailed | TrackerError.NoVideo | TrackerError.VideoError | TrackerError.CameraPermission | TrackerError.NoAudio | TrackerError.AudioError | TrackerError.MicPermission;
15910
16018
  export namespace TriStateBoolean {
15911
16019
  export interface Unknown extends EnumItem {
15912
16020
  Name: "Unknown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.634",
3
+ "version": "1.0.637",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },