isaacscript-common 80.2.2 → 80.2.4

package/dist/functions/trinkets.lua

@@ -28,6 +28,7 @@ local ____sprites = require("functions.sprites")
 local clearSprite = ____sprites.clearSprite
 local ____types = require("functions.types")
 local asNumber = ____types.asNumber
+local asTrinketType = ____types.asTrinketType
 function ____exports.isGoldenTrinketType(self, trinketType)
     return asNumber(nil, trinketType) > GOLDEN_TRINKET_ADJUSTMENT
 end
@@ -130,6 +131,11 @@ end
 function ____exports.isModdedTrinketType(self, trinketType)
     return not ____exports.isVanillaTrinketType(nil, trinketType)
 end
+function ____exports.isValidTrinketType(self, trinketType)
+    local potentialTrinketType = asTrinketType(nil, trinketType)
+    local itemConfigItem = itemConfig:GetTrinket(potentialTrinketType)
+    return itemConfigItem ~= nil
+end
 --- Helper function to generate a new sprite based on a collectible. If the provided collectible type
 -- is invalid, a sprite with a Curse of the Blind question mark will be returned.
 function ____exports.newTrinketSprite(self, trinketType)

package/dist/functions/types.d.ts

@@ -130,4 +130,13 @@ export declare function isPrimitive(variable: unknown): variable is boolean | nu
 export declare function isString(variable: unknown): variable is string;
 export declare function isTable(variable: unknown): variable is LuaMap<AnyNotNil, unknown>;
 export declare function isUserdata(variable: unknown): variable is LuaUserdata;
+/**
+ * Helper function to convert a string to an integer. Returns undefined if the string is not an
+ * integer.
+ *
+ * Under the hood, this uses the built-in `tonumber` and `math.floor` functions.
+ *
+ * This is named `parseIntSafe` in order to match the helper function in `isaacscript-common-ts`.
+ */
+export declare function parseIntSafe(string: string): int | undefined;
 //# sourceMappingURL=types.d.ts.map

package/dist/functions/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;AAEH,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,WAAW,CAEnD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,GAAG,CAM5D;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAExC;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;AAEH,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,WAAW,CAEnD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,GAAG,CAM5D;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAExC;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAe5D"}

package/dist/functions/types.lua

@@ -119,4 +119,21 @@ end
 function ____exports.isUserdata(self, variable)
     return type(variable) == "userdata"
 end
+--- Helper function to convert a string to an integer. Returns undefined if the string is not an
+-- integer.
+-- 
+-- Under the hood, this uses the built-in `tonumber` and `math.floor` functions.
+-- 
+-- This is named `parseIntSafe` in order to match the helper function in `isaacscript-common-ts`.
+function ____exports.parseIntSafe(self, ____string)
+    if not ____exports.isString(nil, ____string) then
+        return nil
+    end
+    local number = tonumber(____string)
+    if number == nil then
+        return nil
+    end
+    local flooredNumber = math.floor(number)
+    return number == flooredNumber and flooredNumber or nil
+end
 return ____exports

package/dist/index.rollup.d.ts

@@ -4652,10 +4652,6 @@ export declare const FIRST_PILL_COLOR = PillColor.BLUE_BLUE;
 /** Equal to `PillEffect.BAD_GAS`. */
 export declare const FIRST_PILL_EFFECT = PillEffect.BAD_GAS;
 
-export declare const FIRST_ROOM_TYPE = RoomType.DEFAULT;
-
-export declare const FIRST_STAGE = LevelStage.BASEMENT_1;
-
 /** Equal to `TrinketType.SWALLOWED_PENNY`. */
 export declare const FIRST_TRINKET_TYPE = TrinketType.SWALLOWED_PENNY;
 
@@ -5443,8 +5439,12 @@ export declare function getCollectibleDevilHeartPrice(collectibleOrCollectibleTy
 export declare function getCollectibleGfxFilename(collectibleOrCollectibleType: EntityPickup | CollectibleType | -1): string;
 
 /**
- * Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
- * provided collectible type was not valid.
+ * Helper function to get the initial amount of charges that a collectible has. In most cases, when
+ * picking up an active collectible for the first time, it will be fully charged, which corresponds
+ * to an `InitCharge` value of -1. However, in some cases, this may be different. For example,
+ * Eden's Soul starts without any charges, so it has an `InitCharge` value of 0.
+ *
+ * This function returns 0 if the provided collectible type was not valid.
  */
 export declare function getCollectibleInitCharge(collectibleOrCollectibleType: EntityPickup | CollectibleType): int;
 
@@ -6492,8 +6492,9 @@ export declare function getNormalTrinketType(trinketType: TrinketType): TrinketT
 export declare function getNPCs(entityType?: EntityType | -1, variant?: number, subType?: number, ignoreFriendly?: boolean): EntityNPC[];
 
 /**
- * Helper function to safely get number values from specific keys on a Lua table. Will throw an
- * error if the specific value does not exist on the table or if it cannot be converted to a number.
+ * Helper function to safely get number values from specific keys on a Lua table. If the values are
+ * strings, they will be converted to numbers. Will throw an error if the specific value does not
+ * exist on the table or if it cannot be converted to a number.
  *
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */
@@ -10249,7 +10250,9 @@ export declare function isTSTLSet(object: unknown): object is Set<AnyNotNil>;
 
 export declare function isUserdata(variable: unknown): variable is LuaUserdata;
 
-export declare function isValidCollectibleType(collectibleType: CollectibleType): boolean;
+export declare function isValidCardType(cardType: int): cardType is CardType;
+
+export declare function isValidCollectibleType(collectibleType: int): collectibleType is CollectibleType;
 
 /**
  * Test if a grid position is actually in the given `RoomShape`.
@@ -10258,6 +10261,10 @@ export declare function isValidCollectibleType(collectibleType: CollectibleType)
  */
 export declare function isValidGridPosition(gridPosition: Vector, roomShape: RoomShape): boolean;
 
+export declare function isValidPillEffect(pillEffect: int): pillEffect is PillEffect;
+
+export declare function isValidTrinketType(trinketType: int): trinketType is TrinketType;
+
 export declare function isVanillaCardType(cardType: CardType): boolean;
 
 export declare function isVanillaCharacter(character: PlayerType): boolean;
@@ -10579,26 +10586,10 @@ export declare const LAST_HORSE_PILL_COLOR = PillColor.HORSE_WHITE_YELLOW;
  */
 export declare const LAST_NORMAL_PILL_COLOR = PillColor.WHITE_YELLOW;
 
-export declare const LAST_ROOM_TYPE: RoomType;
-
-export declare const LAST_STAGE: LevelStage;
-
-/**
- * Calculated from the `CardType` enum.
- *
- * Note that this could be calculated from the length of the enum, because card types are
- * contiguous. However, we instead get the highest enum value to be safer and to make the code more
- * consistent with collectibles and trinkets.
- */
+/** Calculated from the `CardType` enum. */
 export declare const LAST_VANILLA_CARD_TYPE: CardType;
 
-/**
- * Calculated from the `PlayerType` enum.
- *
- * Note that this could be calculated from the length of the enum, because characters are
- * contiguous. However, we instead get the highest enum value to be safer and to make the code more
- * consistent with collectibles and trinkets.
- */
+/** Calculated from the `PlayerType` enum. */
 export declare const LAST_VANILLA_CHARACTER: PlayerType;
 
 /**
@@ -10609,13 +10600,7 @@ export declare const LAST_VANILLA_CHARACTER: PlayerType;
  */
 export declare const LAST_VANILLA_COLLECTIBLE_TYPE: CollectibleType;
 
-/**
- * Calculated from the `PillEffect` enum.
- *
- * Note that this could be calculated from the length of the enum, because pill effects are
- * contiguous. However, we instead get the highest enum value to be safer and to make the code more
- * consistent with collectibles and trinkets.
- */
+/** Calculated from the `PillEffect` enum. */
 export declare const LAST_VANILLA_PILL_EFFECT: PillEffect;
 
 /**
@@ -15229,6 +15214,16 @@ export declare function parseEntityID(entityID: string): [entityType: EntityType
  */
 export declare function parseEntityTypeVariantString(entityTypeVariantString: string): [entityType: EntityType, variant: int] | undefined;
 
+/**
+ * Helper function to convert a string to an integer. Returns undefined if the string is not an
+ * integer.
+ *
+ * Under the hood, this uses the built-in `tonumber` and `math.floor` functions.
+ *
+ * This is named `parseIntSafe` in order to match the helper function in `isaacscript-common-ts`.
+ */
+export declare function parseIntSafe(string: string): int | undefined;
+
 /**
  * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
  * undefined if the submitted string was not a proper Semantic Version string.