@rbxts/types 1.0.619 → 1.0.622

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.
@@ -40,6 +40,7 @@ interface Services {
40
40
  EventIngestService: EventIngestService;
41
41
  FaceAnimatorService: FaceAnimatorService;
42
42
  FacialAnimationStreamingService: FacialAnimationStreamingService;
43
+ GamepadService: GamepadService;
43
44
  GamePassService: GamePassService;
44
45
  GroupService: GroupService;
45
46
  GuiService: GuiService;
@@ -10153,6 +10154,21 @@ interface GamePassService extends Instance {
10153
10154
  PlayerHasPass(this: GamePassService, player: Player, gamePassId: number): boolean;
10154
10155
  }
10155
10156
 
10157
+ /** The GamepadService is internally responsible for handling inputs from various controllers (such as an Xbox One controller) */
10158
+ interface GamepadService extends Instance {
10159
+ /**
10160
+ * **DO NOT USE!**
10161
+ *
10162
+ * This field exists to force TypeScript to recognize this as a nominal type
10163
+ * @hidden
10164
+ * @deprecated
10165
+ */
10166
+ readonly _nominal_GamepadService: unique symbol;
10167
+ readonly GamepadCursorEnabled: boolean;
10168
+ DisableGamepadCursor(this: GamepadService): void;
10169
+ EnableGamepadCursor(this: GamepadService, guiObject: GuiObject): void;
10170
+ }
10171
+
10156
10172
  interface GetTextBoundsParams extends Instance {
10157
10173
  /**
10158
10174
  * **DO NOT USE!**
@@ -21053,26 +21069,29 @@ interface MarketplaceService extends Instance {
21053
21069
  * * [Monetization Guides](https://developer.roblox.com/learn-roblox/monetization), learning materials related to monetizing your game
21054
21070
  * Tags: Yields
21055
21071
  */
21072
+ GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
21073
+ GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
21074
+ GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Bundle>): BundleInfo;
21056
21075
  GetProductInfo(
21057
21076
  this: MarketplaceService,
21058
- assetId: number,
21059
- infoType: CastsToEnum<Enum.InfoType.Asset>,
21060
- ): AssetProductInfo;
21077
+ id: number,
21078
+ infoType: CastsToEnum<Enum.InfoType.GamePass>,
21079
+ ): GamePassProductInfo;
21061
21080
  GetProductInfo(
21062
21081
  this: MarketplaceService,
21063
- assetId: number,
21082
+ id: number,
21064
21083
  infoType: CastsToEnum<Enum.InfoType.Product>,
21065
21084
  ): DeveloperProductInfo;
21066
21085
  GetProductInfo(
21067
21086
  this: MarketplaceService,
21068
- assetId: number,
21069
- infoType: CastsToEnum<Enum.InfoType.GamePass>,
21070
- ): AssetProductInfo;
21087
+ id: number,
21088
+ infoType: CastsToEnum<Enum.InfoType.Subscription>,
21089
+ ): SubscriptionProductInfo;
21071
21090
  GetProductInfo(
21072
21091
  this: MarketplaceService,
21073
- assetId: number,
21074
- infoType: CastsToEnum<Enum.InfoType>,
21075
- ): AssetProductInfo | DeveloperProductInfo;
21092
+ id: number,
21093
+ infoType?: CastsToEnum<Enum.InfoType>,
21094
+ ): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
21076
21095
  /**
21077
21096
  * Tags: Yields
21078
21097
  */
@@ -148,37 +148,71 @@ interface ReceiptInfo {
148
148
  interface ProductInfo {
149
149
  /** The name shown on the asset's page */
150
150
  Name: string;
151
- /** The description as shown on the asset's page
152
- * May be `undefined` if the description is empty.
153
- */
151
+ /** The description as shown on the asset's page; May be `undefined` if the description is empty. */
154
152
  Description: string | undefined;
155
153
  /** The cost of purchasing the asset using Robux */
156
- PriceInRobux: number;
154
+ PriceInRobux: number | undefined;
157
155
  /** Timestamp of when the asset was created, e.g. `2018-08-01T17:55:11.98Z` */
158
156
  Created: string;
159
157
  /** Timestamp of when the asset was last updated by its creator, e.g. `2018-08-01T17:55:11.98Z` */
160
158
  Updated: string;
161
- /** Indicates whether the item is marked as 13+ in catalog */
162
- ContentRatingTypeId: number;
163
- /** The minimum Builder's Club subscription necessary to purchase the item */
164
- MinimumMembershipLevel: number;
165
- /** Describes whether the asset can be taken for free */
166
- IsPublicDomain: boolean;
167
- /** Describes whether the asset is a User Product, Developer Product, or Game Pass */
168
- ProductType: "User Product" | "Developer Product" | "Game Pass";
159
+ /** Describes whether the asset is purchasable */
160
+ IsForSale: boolean;
161
+ /** The number of items the asset has been sold */
162
+ Sales: number | undefined;
163
+ ProductId: number;
169
164
  /** A table of information describing the creator of the asset */
170
165
  Creator: {
171
166
  /** Either `User` or `Group` */
172
- CreatorType: "User" | "Group";
167
+ CreatorType: "User" | "Group" | undefined;
173
168
  /** The ID of the creator user or group */
174
169
  CreatorTargetId: number;
175
170
  /** The name/username of the creator */
176
- Name: string;
171
+ Name: string | undefined;
177
172
  };
178
- IconImageAssetId: number;
179
173
  TargetId: number;
180
174
  }
181
175
 
176
+ interface AssetProductInfo extends ProductInfo {
177
+ /** Describes whether the asset is a User Product, Developer Product, or Game Pass */
178
+ ProductType: "User Product";
179
+ /** If InfoType was Asset, this is the ID of the given asset. */
180
+ AssetId: number;
181
+ /** The [type of asset](https://developer.roblox.com/articles/Asset-types) (e.g. place, model, shirt). In TypeScript, you should compare this value to a member of the `AssetTypeId` const enum. */
182
+ AssetTypeId: AssetTypeId;
183
+ /** Describes whether the asset is marked as "new" in the catalog */
184
+ IsNew: boolean;
185
+ /** Describes whether the asset is a "limited item" that is no longer (if ever) sold */
186
+ IsLimited: boolean;
187
+ /** Describes whether the asset is a "limited unique" ("Limited U") item that only has a fixed number sold */
188
+ IsLimitedUnique: boolean;
189
+ /** Describes whether the asset can be taken for free */
190
+ IsPublicDomain: boolean;
191
+ /** The remaining number of items a limited unique item may be sold */
192
+ Remaining: number | undefined;
193
+ /** Indicates whether the item is marked as 13+ in catalog */
194
+ ContentRatingTypeId: number;
195
+ /** The minimum Builder's Club subscription necessary to purchase the item */
196
+ MinimumMembershipLevel: number;
197
+ }
198
+
199
+ interface DeveloperProductInfo extends ProductInfo {
200
+ /** Describes whether the asset is a User Product, Developer Product, or Game Pass */
201
+ ProductType: "Developer Product";
202
+ IconImageAssetId: number;
203
+ }
204
+
205
+ interface GamePassProductInfo extends ProductInfo {
206
+ /** Describes whether the asset is a User Product, Developer Product, or Game Pass */
207
+ ProductType: "Game Pass";
208
+ IconImageAssetId: number;
209
+ }
210
+
211
+ interface SubscriptionProductInfo extends ProductInfo {
212
+ /** Describes whether the asset is a User Product, Developer Product, or Game Pass */
213
+ ProductType: "Subscription";
214
+ }
215
+
182
216
  interface BadgeInfo {
183
217
  /** The name of the badge. */
184
218
  Name: string;
@@ -287,30 +321,6 @@ declare const enum AssetTypeId {
287
321
  EyeAccessory = 58,
288
322
  }
289
323
 
290
- interface AssetProductInfo extends ProductInfo {
291
- /** If InfoType was Asset, this is the ID of the given asset. */
292
- AssetId: number;
293
- /** The [type of asset](https://developer.roblox.com/articles/Asset-types) (e.g. place, model, shirt). In TypeScript, you should compare this value to a member of the `AssetTypeId` const enum. */
294
- AssetTypeId: AssetTypeId;
295
- /** Describes whether the asset is purchasable */
296
- IsForSale: boolean;
297
- /** Describes whether the asset is a "limited item" that is no longer (if ever) sold */
298
- IsLimited: boolean;
299
- /** Describes whether the asset is a "limited unique" ("Limited U") item that only has a fixed number sold */
300
- IsLimitedUnique: boolean;
301
- /** Describes whether the asset is marked as "new" in the catalog */
302
- IsNew: boolean;
303
- /** The remaining number of items a limited unique item may be sold */
304
- Remaining: number;
305
- /** The number of items the asset has been sold */
306
- Sales: number;
307
- }
308
-
309
- interface DeveloperProductInfo extends ProductInfo {
310
- /** If the InfoType was Product, this is the product's ID */
311
- ProductId: number;
312
- }
313
-
314
324
  interface AgentParameters {
315
325
  /** Humanoid radius. Used to determine the minimum separation from obstacles. */
316
326
  AgentRadius?: number;
@@ -603,7 +613,7 @@ interface Axes {
603
613
  type AxesConstructor = new (...axes: Array<Enum.Axis | Enum.NormalId>) => Axes;
604
614
  declare const Axes: AxesConstructor;
605
615
 
606
- interface BrickColor<Number extends number = any, Name extends string = any> {
616
+ interface BrickColor<T extends keyof BrickColorsByNumber = keyof BrickColorsByNumber> {
607
617
  /**
608
618
  * **DO NOT USE!**
609
619
  *
@@ -613,9 +623,9 @@ interface BrickColor<Number extends number = any, Name extends string = any> {
613
623
  */
614
624
  readonly _nominal_BrickColor: unique symbol;
615
625
  /** The unique number that identifies the BrickColor */
616
- readonly Number: number extends Number ? keyof BrickColorsByNumber : Number;
626
+ readonly Number: T;
617
627
  /** The name associated with the BrickColor */
618
- readonly Name: string extends Name ? BrickColorsByNumber[keyof BrickColorsByNumber] : Name;
628
+ readonly Name: BrickColorsByNumber[T];
619
629
  /** The Color3 associated with the BrickColor */
620
630
  readonly Color: Color3;
621
631
  /** The red component (between 0 and 1) */
@@ -973,30 +983,29 @@ interface BrickColorConstructor {
973
983
  random: () => BrickColor;
974
984
 
975
985
  /** Returns a White BrickColor */
976
- White: () => BrickColor<1, "White">;
986
+ White: () => BrickColor<1>;
977
987
  /** Returns a Gray BrickColor */
978
- Gray: () => BrickColor<194, "Medium stone grey">;
988
+ Gray: () => BrickColor<194>;
979
989
  /** Returns a DarkGray BrickColor */
980
- DarkGray: () => BrickColor<199, "Dark stone grey">;
990
+ DarkGray: () => BrickColor<199>;
981
991
  /** Returns a Black BrickColor */
982
- Black: () => BrickColor<26, "Black">;
992
+ Black: () => BrickColor<26>;
983
993
  /** Returns a Red BrickColor */
984
- Red: () => BrickColor<21, "Bright red">;
994
+ Red: () => BrickColor<21>;
985
995
  /** Returns a Yellow BrickColor */
986
- Yellow: () => BrickColor<24, "Bright yellow">;
996
+ Yellow: () => BrickColor<24>;
987
997
  /** Returns a Green BrickColor */
988
- Green: () => BrickColor<28, "Dark green">;
998
+ Green: () => BrickColor<28>;
989
999
  /** Returns a Blue BrickColor */
990
- Blue: () => BrickColor<23, "Bright blue">;
1000
+ Blue: () => BrickColor<23>;
991
1001
 
992
1002
  /** Constructs a BrickColor from its name. */
993
1003
  new <T extends BrickColorsByNumber[keyof BrickColorsByNumber]>(val: T): BrickColor<
994
- { [K in keyof BrickColorsByNumber]: T extends BrickColorsByNumber[K] ? K : never }[keyof BrickColorsByNumber],
995
- T
1004
+ { [K in keyof BrickColorsByNumber]: T extends BrickColorsByNumber[K] ? K : never }[keyof BrickColorsByNumber]
996
1005
  >;
997
1006
 
998
1007
  /** Constructs a BrickColor from its numerical index. */
999
- new <T extends keyof BrickColorsByNumber>(val: T): BrickColor<T, BrickColorsByNumber[T]>;
1008
+ new <T extends keyof BrickColorsByNumber>(val: T): BrickColor<T>;
1000
1009
 
1001
1010
  /** Constructs a BrickColor from its numerical index. */
1002
1011
  new (val: number): BrickColor;
@@ -1008,13 +1017,8 @@ interface BrickColorConstructor {
1008
1017
  new (color: Color3): BrickColor;
1009
1018
 
1010
1019
  /** Constructs a BrickColor from its palette index. */
1011
- palette: {
1012
- <T extends keyof BrickColorsByPalette>(paletteValue: T): BrickColor<
1013
- BrickColorsByPalette[T],
1014
- BrickColorsByNumber[BrickColorsByPalette[T]]
1015
- >;
1016
- (paletteValue: number): BrickColor;
1017
- };
1020
+ palette<T extends keyof BrickColorsByPalette>(this: void, paletteValue: T): BrickColor<BrickColorsByPalette[T]>;
1021
+ palette(this: void, paletteValue: number): BrickColor;
1018
1022
  }
1019
1023
 
1020
1024
  declare const BrickColor: BrickColorConstructor;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.619",
3
+ "version": "1.0.622",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },