isaacscript-common 8.5.0 → 8.6.0

package/dist/features/playerInventory.d.ts

@@ -3,9 +3,6 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
  *
- * Note that this does not include active collectibles that have since been dropped for other
- * collectibles.
- *
  * In the case of inventory initialization or the case where the player rerolls their build in the
  * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
  * that the items were actually given to the player. In this case, the inventory will be in the
@@ -17,6 +14,17 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * would not be updated. In vanilla, this situation would never happen, but another mod might do
  * this for some reason. (With that said, the next time that a collectible is normally added or
  * removed, it would trigger a re-scan, and the previous changes would be picked up.)
+ *
+ * @param player The player to get the inventory for.
+ * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+ *                                 is true.
  */
 export declare function getPlayerInventory(player: EntityPlayer, includeActiveCollectibles?: boolean): CollectibleType[];
+/**
+ * Helper function to get the last passive collectible that the player picked up. In most cases,
+ * this will be the passive that is removed when the player would use Clicker.
+ *
+ * Returns undefined if the player does not have any passive collectibles.
+ */
+export declare function getPlayerLastPassiveCollectible(player: EntityPlayer): CollectibleType | undefined;
 //# sourceMappingURL=playerInventory.d.ts.map

package/dist/features/playerInventory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playerInventory.d.ts","sourceRoot":"","sources":["../../src/features/playerInventory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAe,MAAM,8BAA8B,CAAC;AAyG5E;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,yBAAyB,UAAO,GAC/B,eAAe,EAAE,CAanB"}
+{"version":3,"file":"playerInventory.d.ts","sourceRoot":"","sources":["../../src/features/playerInventory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAe,MAAM,8BAA8B,CAAC;AA6G5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,yBAAyB,UAAO,GAC/B,eAAe,EAAE,CAanB;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,YAAY,GACnB,eAAe,GAAG,SAAS,CAK7B"}

package/dist/features/playerInventory.lua

@@ -15,6 +15,7 @@ local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNot
 local ____array = require("functions.array")
 local arrayRemoveInPlace = ____array.arrayRemoveInPlace
 local copyArray = ____array.copyArray
+local getLastElement = ____array.getLastElement
 local ____collectibles = require("functions.collectibles")
 local isActiveCollectible = ____collectibles.isActiveCollectible
 local ____collectibleSet = require("functions.collectibleSet")
@@ -84,9 +85,6 @@ end
 --- Helper function to get all of the collectibles that the player has gotten so far on this run, in
 -- order.
 -- 
--- Note that this does not include active collectibles that have since been dropped for other
--- collectibles.
--- 
 -- In the case of inventory initialization or the case where the player rerolls their build in the
 -- middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
 -- that the items were actually given to the player. In this case, the inventory will be in the
@@ -98,6 +96,10 @@ end
 -- would not be updated. In vanilla, this situation would never happen, but another mod might do
 -- this for some reason. (With that said, the next time that a collectible is normally added or
 -- removed, it would trigger a re-scan, and the previous changes would be picked up.)
+-- 
+-- @param player The player to get the inventory for.
+-- @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+-- is true.
 function ____exports.getPlayerInventory(self, player, includeActiveCollectibles)
     if includeActiveCollectibles == nil then
         includeActiveCollectibles = true
@@ -113,4 +115,13 @@ function ____exports.getPlayerInventory(self, player, includeActiveCollectibles)
         function(____, collectibleType) return not isActiveCollectible(nil, collectibleType) end
     )
 end
+--- Helper function to get the last passive collectible that the player picked up. In most cases,
+-- this will be the passive that is removed when the player would use Clicker.
+-- 
+-- Returns undefined if the player does not have any passive collectibles.
+function ____exports.getPlayerLastPassiveCollectible(self, player)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local inventory = ____exports.getPlayerInventory(nil, player, false)
+    return getLastElement(nil, inventory)
+end
 return ____exports

package/dist/functions/bosses.d.ts

@@ -19,6 +19,9 @@ export declare function getAliveBosses(entityType?: EntityType, variant?: number
  *
  * The set contains strings with the entity type and variant, separated by a period.
  *
+ * Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+ * and Gabriel.).
+ *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
  *
  * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!

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

@@ -1 +1 @@
-{"version":3,"file":"bosses.d.ts","sourceRoot":"","sources":["../../src/functions/bosses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAyBtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,UAAO,GACxB,WAAW,CAAC,MAAM,CAAC,CAIrB;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,GAAG,EACV,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAYjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,GAAG,EACb,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,GAAG,GACT,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAOjC;AAED,6FAA6F;AAC7F,wBAAgB,KAAK,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,EAC7C,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAyBX;AAmCD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAYX"}
+{"version":3,"file":"bosses.d.ts","sourceRoot":"","sources":["../../src/functions/bosses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAyBtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,UAAO,GACxB,WAAW,CAAC,MAAM,CAAC,CAIrB;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,GAAG,EACV,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAYjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,GAAG,EACb,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,GAAG,GACT,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAOjC;AAED,6FAA6F;AAC7F,wBAAgB,KAAK,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,EAC7C,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAyBX;AAmCD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAYX"}

package/dist/functions/bosses.lua

@@ -107,6 +107,9 @@ end
 -- 
 -- The set contains strings with the entity type and variant, separated by a period.
 -- 
+-- Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+-- and Gabriel.).
+-- 
 -- Also see the `getBossSet` and `getCombinedBossSet` functions.
 -- 
 -- @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!

package/dist/index.d.ts

@@ -2280,6 +2280,9 @@ export declare function getAliveNPCs(entityType?: EntityType, variant?: number,
  *
  * The set contains strings with the entity type and variant, separated by a period.
  *
+ * Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+ * and Gabriel.).
+ *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
  *
  * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
@@ -4022,9 +4025,6 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
  *
- * Note that this does not include active collectibles that have since been dropped for other
- * collectibles.
- *
  * In the case of inventory initialization or the case where the player rerolls their build in the
  * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
  * that the items were actually given to the player. In this case, the inventory will be in the
@@ -4036,6 +4036,10 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * would not be updated. In vanilla, this situation would never happen, but another mod might do
  * this for some reason. (With that said, the next time that a collectible is normally added or
  * removed, it would trigger a re-scan, and the previous changes would be picked up.)
+ *
+ * @param player The player to get the inventory for.
+ * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+ *                                 is true.
  */
 export declare function getPlayerInventory(player: EntityPlayer, includeActiveCollectibles?: boolean): CollectibleType[];
 
@@ -4045,6 +4049,14 @@ export declare function getPlayerInventory(player: EntityPlayer, includeActiveCo
  */
 export declare function getPlayerLastHeart(player: EntityPlayer): HealthType;
 
+/**
+ * Helper function to get the last passive collectible that the player picked up. In most cases,
+ * this will be the passive that is removed when the player would use Clicker.
+ *
+ * Returns undefined if the player does not have any passive collectibles.
+ */
+export declare function getPlayerLastPassiveCollectible(player: EntityPlayer): CollectibleType | undefined;
+
 /**
  * Returns the maximum heart containers that the provided player can have. Normally, this is 12, but
  * it can change depending on the character (e.g. Keeper) and other things (e.g. Mother's Kiss).

package/dist/sets/bossSets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bossSets.d.ts","sourceRoot":"","sources":["../../src/sets/bossSets.ts"],"names":[],"mappings":";AAibA,eAAO,MAAM,mCAAmC,EAAE,WAAW,CAC3D,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAarC,CAAC;AAEH,eAAO,MAAM,8BAA8B,EAAE,WAAW,CACtD,GAAG,EACH,WAAW,CAAC,MAAM,CAAC,CAanB,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAQ7C,CAAC;AAiBH,eAAO,MAAM,qCAAqC,EAAE,WAAW,CAAC,MAAM,CACpC,CAAC"}
+{"version":3,"file":"bossSets.d.ts","sourceRoot":"","sources":["../../src/sets/bossSets.ts"],"names":[],"mappings":";AAibA,eAAO,MAAM,mCAAmC,EAAE,WAAW,CAC3D,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAarC,CAAC;AAEH,eAAO,MAAM,8BAA8B,EAAE,WAAW,CACtD,GAAG,EACH,WAAW,CAAC,MAAM,CAAC,CAanB,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAQ7C,CAAC;AAEH,eAAO,MAAM,qCAAqC,qBACX,CAAC"}

package/dist/sets/bossSets.lua

@@ -7,6 +7,7 @@ local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
 local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local Map = ____lualib.Map
 local ____exports = {}
+local getAllBossesExcludingStoryBossesSet
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BigHornVariant = ____isaac_2Dtypescript_2Ddefinitions.BigHornVariant
 local ChubVariant = ____isaac_2Dtypescript_2Ddefinitions.ChubVariant
@@ -43,6 +44,21 @@ local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____storyBossesSet = require("sets.storyBossesSet")
 local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
+function getAllBossesExcludingStoryBossesSet(self)
+    local allBossesExcludingStoryBossesSet = copySet(nil, ____exports.ALL_BOSSES_SET)
+    local allBosses = {__TS__Spread(____exports.ALL_BOSSES_SET:values())}
+    for ____, entityTypeVariantString in ipairs(allBosses) do
+        local tuple = parseEntityTypeVariantString(nil, entityTypeVariantString)
+        if tuple == nil then
+            error("Failed to parse a boss tuple when constructing the story boss set.")
+        end
+        local entityType, _variant = table.unpack(tuple)
+        if STORY_BOSSES_SET:has(entityType) then
+            allBossesExcludingStoryBossesSet:delete(entityTypeVariantString)
+        end
+    end
+    return allBossesExcludingStoryBossesSet
+end
 --- Contains just the bosses in Basement (not e.g. Burning Basement).
 local BASEMENT_BOSSES_SET = __TS__New(
     Set,
@@ -557,17 +573,5 @@ ____exports.ALL_BOSSES_SET = __TS__New(
     ____Set_13,
     {__TS__SparseArraySpread(____array_12)}
 )
-local allBossesExcludingStoryBossesSet = copySet(nil, ____exports.ALL_BOSSES_SET)
-local allBosses = {__TS__Spread(____exports.ALL_BOSSES_SET:values())}
-for ____, entityTypeVariantString in ipairs(allBosses) do
-    local tuple = parseEntityTypeVariantString(nil, entityTypeVariantString)
-    if tuple == nil then
-        error("Failed to parse a boss tuple when constructing the story boss set.")
-    end
-    local entityType, _variant = table.unpack(tuple)
-    if STORY_BOSSES_SET:has(entityType) then
-        allBossesExcludingStoryBossesSet:delete(entityTypeVariantString)
-    end
-end
-____exports.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = allBossesExcludingStoryBossesSet
+____exports.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = getAllBossesExcludingStoryBossesSet(nil)
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/features/playerInventory.ts

@@ -3,7 +3,11 @@ import { DefaultMap } from "../classes/DefaultMap";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { arrayRemoveInPlace, copyArray } from "../functions/array";
+import {
+  arrayRemoveInPlace,
+  copyArray,
+  getLastElement,
+} from "../functions/array";
 import { isActiveCollectible } from "../functions/collectibles";
 import { getCollectibleArray } from "../functions/collectibleSet";
 import {
@@ -107,9 +111,6 @@ function postCollectibleRemoved(
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
  *
- * Note that this does not include active collectibles that have since been dropped for other
- * collectibles.
- *
  * In the case of inventory initialization or the case where the player rerolls their build in the
  * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
  * that the items were actually given to the player. In this case, the inventory will be in the
@@ -121,6 +122,10 @@ function postCollectibleRemoved(
  * would not be updated. In vanilla, this situation would never happen, but another mod might do
  * this for some reason. (With that said, the next time that a collectible is normally added or
  * removed, it would trigger a re-scan, and the previous changes would be picked up.)
+ *
+ * @param player The player to get the inventory for.
+ * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+ *                                 is true.
  */
 export function getPlayerInventory(
   player: EntityPlayer,
@@ -139,3 +144,18 @@ export function getPlayerInventory(
     (collectibleType) => !isActiveCollectible(collectibleType),
   );
 }
+
+/**
+ * Helper function to get the last passive collectible that the player picked up. In most cases,
+ * this will be the passive that is removed when the player would use Clicker.
+ *
+ * Returns undefined if the player does not have any passive collectibles.
+ */
+export function getPlayerLastPassiveCollectible(
+  player: EntityPlayer,
+): CollectibleType | undefined {
+  errorIfFeaturesNotInitialized(FEATURE_NAME);
+
+  const inventory = getPlayerInventory(player, false);
+  return getLastElement(inventory);
+}

package/src/functions/bosses.ts

@@ -56,6 +56,9 @@ export function getAliveBosses(
  *
  * The set contains strings with the entity type and variant, separated by a period.
  *
+ * Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+ * and Gabriel.).
+ *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
  *
  * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!

package/src/sets/bossSets.ts

@@ -475,20 +475,29 @@ export const ALL_BOSSES_SET: ReadonlySet<string> = new Set([
   ...ALL_STAGE_11_BOSSES_SET.values(),
 ]);
 
-// Since story bosses are stored by entity type, we copy the existing bosses and filter them (to
-// avoid having to hard-code story boss variants).
-const allBossesExcludingStoryBossesSet = copySet(ALL_BOSSES_SET);
-const allBosses = [...ALL_BOSSES_SET.values()];
-for (const entityTypeVariantString of allBosses) {
-  const tuple = parseEntityTypeVariantString(entityTypeVariantString);
-  if (tuple === undefined) {
-    error("Failed to parse a boss tuple when constructing the story boss set.");
+export const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET =
+  getAllBossesExcludingStoryBossesSet();
+
+/**
+ * Since story bosses are stored by entity type, we copy the existing bosses and filter them (to
+ * avoid having to hard-code story boss variants).
+ */
+function getAllBossesExcludingStoryBossesSet(): ReadonlySet<string> {
+  const allBossesExcludingStoryBossesSet = copySet(ALL_BOSSES_SET);
+  const allBosses = [...ALL_BOSSES_SET.values()];
+  for (const entityTypeVariantString of allBosses) {
+    const tuple = parseEntityTypeVariantString(entityTypeVariantString);
+    if (tuple === undefined) {
+      error(
+        "Failed to parse a boss tuple when constructing the story boss set.",
+      );
+    }
+
+    const [entityType, _variant] = tuple;
+    if (STORY_BOSSES_SET.has(entityType)) {
+      allBossesExcludingStoryBossesSet.delete(entityTypeVariantString);
+    }
   }
 
-  const [entityType, _variant] = tuple;
-  if (STORY_BOSSES_SET.has(entityType)) {
-    allBossesExcludingStoryBossesSet.delete(entityTypeVariantString);
-  }
+  return allBossesExcludingStoryBossesSet;
 }
-export const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET: ReadonlySet<string> =
-  allBossesExcludingStoryBossesSet;