isaacscript-common 47.3.0 → 47.5.0

package/dist/index.rollup.d.ts

@@ -74,6 +74,7 @@ import { RoomShape } from 'isaac-typescript-definitions';
 import { RoomTransitionAnim } from 'isaac-typescript-definitions';
 import { RoomType } from 'isaac-typescript-definitions';
 import type { SackSubType } from 'isaac-typescript-definitions';
+import { SeedEffect } from 'isaac-typescript-definitions';
 import type { SlotVariant } from 'isaac-typescript-definitions';
 import type { StageID } from 'isaac-typescript-definitions';
 import { StageType } from 'isaac-typescript-definitions';
@@ -1054,6 +1055,9 @@ export declare function anyPlayerHoldingItem(): boolean;
  */
 export declare function anyPlayerIs(...matchingCharacters: PlayerType[]): boolean;
 
+/**
+ * Helper function to see if any seed effects (i.e. Easter Eggs) are enabled for the current run.
+ */
 export declare function anySeedEffectEnabled(): boolean;
 
 declare type Arr<N extends number, T extends unknown[] = []> = T["length"] extends N ? T : Arr<N, [...T, unknown]>;
@@ -1352,6 +1356,9 @@ export declare function canPlayerCrushRocks(player: EntityPlayer): boolean;
 /**
  * Helper function to see if the current run can unlock achievements. For example, if playing on a
  * set seed or in a victory lap, achievements are disabled.
+ *
+ * Under the hood, this is determined by spawning a Greed Donation Machine and then seeing if it
+ * exists before removing it.
  */
 export declare function canRunUnlockAchievements(): boolean;
 
@@ -7306,6 +7313,11 @@ export declare function getScreenTopLeftPos(): Readonly<Vector>;
 
 export declare function getScreenTopRightPos(): Readonly<Vector>;
 
+/**
+ * Helper function to get the seed effects (i.e. Easter Eggs) that are enabled for the current run.
+ */
+export declare function getSeedEffects(): SeedEffect[];
+
 /**
  * Helper function to get all possible combinations of the given set. This includes the combination
  * of an empty set.
@@ -14021,9 +14033,9 @@ export declare function onFirstFloor(): boolean;
 export declare function onRepentanceStage(): boolean;
 
 /**
- * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
- * pressing tab on the character selection screen). When the player resets the game on a set seed,
- * the game will not switch to a different seed.
+ * Helper function to check whether the player is playing on a set seed (i.e. that they entered in a
+ * specific seed by pressing tab on the character selection screen). When the player resets the game
+ * on a set seed, the game will not switch to a different seed.
  *
  * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
  * `Seeds.IsCustomRun` method.
@@ -14103,6 +14115,12 @@ export declare function onStageWithShovelTrapdoors(): boolean;
  */
 export declare function onStageWithStoryBoss(): boolean;
 
+/**
+ * Helper function to check whether the player is on a Victory Lap (i.e. they answered "yes" to the
+ * popup that happens after defeating The Lamb).
+ */
+export declare function onVictoryLap(): boolean;
+
 /**
  * For the purposes of this function, doors to Secret Rooms or Super Secret Rooms that have not been
  * discovered yet will not be opened.
@@ -16630,8 +16648,8 @@ export declare function setTrinketSprite(trinket: EntityPickup, pngPath: string
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *
- * This is useful to revert the behavior where playing on a set and restarting the game will not
- * take you to a new seed.
+ * This is useful to revert the behavior where playing on a set seed and restarting the game will
+ * not take you to a new seed.
  *
  * Under the hood, this function calls the `Seeds.Reset` method and the
  * `Seeds.Restart(Challenge.NULL)` method.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 47.3.0
+isaacscript-common 47.5.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -22503,7 +22503,7 @@ return ____exports
  end,
 ["src.functions.run"] = function(...) 
 local ____lualib = require("lualib_bundle")
-local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
@@ -22526,10 +22526,8 @@ local ____log = require("src.functions.log")
 local log = ____log.log
 function ____exports.anySeedEffectEnabled(self)
     local seeds = game:GetSeeds()
-    return __TS__ArraySome(
-        SEED_EFFECTS,
-        function(____, seedEffect) return seedEffect ~= SeedEffect.NORMAL and seeds:HasSeedEffect(seedEffect) end
-    )
+    local numSeedEffects = seeds:CountSeedEffects()
+    return numSeedEffects > 0
 end
 function ____exports.anyEasterEggEnabled(self)
     return ____exports.anySeedEffectEnabled(nil)
@@ -22540,6 +22538,13 @@ function ____exports.canRunUnlockAchievements(self)
     greedDonationMachine:Remove()
     return canUnlockAchievements
 end
+function ____exports.getSeedEffects(self)
+    local seeds = game:GetSeeds()
+    return __TS__ArrayFilter(
+        SEED_EFFECTS,
+        function(____, seedEffect) return seedEffect ~= SeedEffect.NORMAL and seeds:HasSeedEffect(seedEffect) end
+    )
+end
 function ____exports.isGreedMode(self)
     return game.Difficulty == Difficulty.GREED or game.Difficulty == Difficulty.GREEDIER
 end
@@ -22549,6 +22554,10 @@ function ____exports.onSetSeed(self)
     local challenge = Isaac.GetChallenge()
     return challenge == Challenge.NULL and customRun
 end
+function ____exports.onVictoryLap(self)
+    local numVictoryLaps = game:GetVictoryLap()
+    return numVictoryLaps > 0
+end
 function ____exports.restart(self, character)
     if character == nil then
         local command = "restart"

package/dist/src/functions/run.d.ts

@@ -1,26 +1,42 @@
 import type { PlayerType } from "isaac-typescript-definitions";
+import { SeedEffect } from "isaac-typescript-definitions";
 /** Alias for the `anySeedEffectEnabled` function. */
 export declare function anyEasterEggEnabled(): boolean;
+/**
+ * Helper function to see if any seed effects (i.e. Easter Eggs) are enabled for the current run.
+ */
 export declare function anySeedEffectEnabled(): boolean;
 /**
  * Helper function to see if the current run can unlock achievements. For example, if playing on a
  * set seed or in a victory lap, achievements are disabled.
+ *
+ * Under the hood, this is determined by spawning a Greed Donation Machine and then seeing if it
+ * exists before removing it.
  */
 export declare function canRunUnlockAchievements(): boolean;
+/**
+ * Helper function to get the seed effects (i.e. Easter Eggs) that are enabled for the current run.
+ */
+export declare function getSeedEffects(): SeedEffect[];
 /**
  * Helper function to check if the difficulty of the current run is equal to `Difficulty.GREED` or
  * `Difficulty.GREEDIER`.
  */
 export declare function isGreedMode(): boolean;
 /**
- * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
- * pressing tab on the character selection screen). When the player resets the game on a set seed,
- * the game will not switch to a different seed.
+ * Helper function to check whether the player is playing on a set seed (i.e. that they entered in a
+ * specific seed by pressing tab on the character selection screen). When the player resets the game
+ * on a set seed, the game will not switch to a different seed.
  *
  * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
  * `Seeds.IsCustomRun` method.
  */
 export declare function onSetSeed(): boolean;
+/**
+ * Helper function to check whether the player is on a Victory Lap (i.e. they answered "yes" to the
+ * popup that happens after defeating The Lamb).
+ */
+export declare function onVictoryLap(): boolean;
 /**
  * Helper function to restart the run using the console command of "restart". If the player is
  * playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
@@ -32,8 +48,8 @@ export declare function restart(character?: PlayerType): void;
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *
- * This is useful to revert the behavior where playing on a set and restarting the game will not
- * take you to a new seed.
+ * This is useful to revert the behavior where playing on a set seed and restarting the game will
+ * not take you to a new seed.
  *
  * Under the hood, this function calls the `Seeds.Reset` method and the
  * `Seeds.Restart(Challenge.NULL)` method.

package/dist/src/functions/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAe/D,qDAAqD;AACrD,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED,wBAAgB,oBAAoB,IAAI,OAAO,CAO9C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAStC,qDAAqD;AACrD,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,UAAU,EAAE,CAO7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}

package/dist/src/functions/run.lua

@@ -1,5 +1,5 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
@@ -20,12 +20,11 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local spawnSlot = ____entitiesSpecific.spawnSlot
 local ____log = require("src.functions.log")
 local log = ____log.log
+--- Helper function to see if any seed effects (i.e. Easter Eggs) are enabled for the current run.
 function ____exports.anySeedEffectEnabled(self)
     local seeds = game:GetSeeds()
-    return __TS__ArraySome(
-        SEED_EFFECTS,
-        function(____, seedEffect) return seedEffect ~= SeedEffect.NORMAL and seeds:HasSeedEffect(seedEffect) end
-    )
+    local numSeedEffects = seeds:CountSeedEffects()
+    return numSeedEffects > 0
 end
 --- Alias for the `anySeedEffectEnabled` function.
 function ____exports.anyEasterEggEnabled(self)
@@ -33,20 +32,31 @@ function ____exports.anyEasterEggEnabled(self)
 end
 --- Helper function to see if the current run can unlock achievements. For example, if playing on a
 -- set seed or in a victory lap, achievements are disabled.
+-- 
+-- Under the hood, this is determined by spawning a Greed Donation Machine and then seeing if it
+-- exists before removing it.
 function ____exports.canRunUnlockAchievements(self)
     local greedDonationMachine = spawnSlot(nil, SlotVariant.GREED_DONATION_MACHINE, 0, VectorZero)
     local canUnlockAchievements = greedDonationMachine:Exists()
     greedDonationMachine:Remove()
     return canUnlockAchievements
 end
+--- Helper function to get the seed effects (i.e. Easter Eggs) that are enabled for the current run.
+function ____exports.getSeedEffects(self)
+    local seeds = game:GetSeeds()
+    return __TS__ArrayFilter(
+        SEED_EFFECTS,
+        function(____, seedEffect) return seedEffect ~= SeedEffect.NORMAL and seeds:HasSeedEffect(seedEffect) end
+    )
+end
 --- Helper function to check if the difficulty of the current run is equal to `Difficulty.GREED` or
 -- `Difficulty.GREEDIER`.
 function ____exports.isGreedMode(self)
     return game.Difficulty == Difficulty.GREED or game.Difficulty == Difficulty.GREEDIER
 end
---- Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
--- pressing tab on the character selection screen). When the player resets the game on a set seed,
--- the game will not switch to a different seed.
+--- Helper function to check whether the player is playing on a set seed (i.e. that they entered in a
+-- specific seed by pressing tab on the character selection screen). When the player resets the game
+-- on a set seed, the game will not switch to a different seed.
 -- 
 -- Under the hood, this checks if the current challenge is `Challenge.NULL` and the
 -- `Seeds.IsCustomRun` method.
@@ -56,6 +66,12 @@ function ____exports.onSetSeed(self)
     local challenge = Isaac.GetChallenge()
     return challenge == Challenge.NULL and customRun
 end
+--- Helper function to check whether the player is on a Victory Lap (i.e. they answered "yes" to the
+-- popup that happens after defeating The Lamb).
+function ____exports.onVictoryLap(self)
+    local numVictoryLaps = game:GetVictoryLap()
+    return numVictoryLaps > 0
+end
 --- Helper function to restart the run using the console command of "restart". If the player is
 -- playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
 -- will put the player on a run with an entirely new seed.
@@ -78,8 +94,8 @@ function ____exports.restart(self, character)
 end
 --- Helper function to change the run status to that of an unseeded run with a new random seed.
 -- 
--- This is useful to revert the behavior where playing on a set and restarting the game will not
--- take you to a new seed.
+-- This is useful to revert the behavior where playing on a set seed and restarting the game will
+-- not take you to a new seed.
 -- 
 -- Under the hood, this function calls the `Seeds.Reset` method and the
 -- `Seeds.Restart(Challenge.NULL)` method.

package/package.json

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

package/src/functions/run.ts

@@ -18,18 +18,22 @@ export function anyEasterEggEnabled(): boolean {
   return anySeedEffectEnabled();
 }
 
+/**
+ * Helper function to see if any seed effects (i.e. Easter Eggs) are enabled for the current run.
+ */
 export function anySeedEffectEnabled(): boolean {
   const seeds = game.GetSeeds();
+  const numSeedEffects = seeds.CountSeedEffects();
 
-  return SEED_EFFECTS.some(
-    (seedEffect) =>
-      seedEffect !== SeedEffect.NORMAL && seeds.HasSeedEffect(seedEffect),
-  );
+  return numSeedEffects > 0;
 }
 
 /**
  * Helper function to see if the current run can unlock achievements. For example, if playing on a
  * set seed or in a victory lap, achievements are disabled.
+ *
+ * Under the hood, this is determined by spawning a Greed Donation Machine and then seeing if it
+ * exists before removing it.
  */
 export function canRunUnlockAchievements(): boolean {
   const greedDonationMachine = spawnSlot(
@@ -43,6 +47,18 @@ export function canRunUnlockAchievements(): boolean {
   return canUnlockAchievements;
 }
 
+/**
+ * Helper function to get the seed effects (i.e. Easter Eggs) that are enabled for the current run.
+ */
+export function getSeedEffects(): SeedEffect[] {
+  const seeds = game.GetSeeds();
+
+  return SEED_EFFECTS.filter(
+    (seedEffect) =>
+      seedEffect !== SeedEffect.NORMAL && seeds.HasSeedEffect(seedEffect),
+  );
+}
+
 /**
  * Helper function to check if the difficulty of the current run is equal to `Difficulty.GREED` or
  * `Difficulty.GREEDIER`.
@@ -55,9 +71,9 @@ export function isGreedMode(): boolean {
 }
 
 /**
- * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
- * pressing tab on the character selection screen). When the player resets the game on a set seed,
- * the game will not switch to a different seed.
+ * Helper function to check whether the player is playing on a set seed (i.e. that they entered in a
+ * specific seed by pressing tab on the character selection screen). When the player resets the game
+ * on a set seed, the game will not switch to a different seed.
  *
  * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
  * `Seeds.IsCustomRun` method.
@@ -70,6 +86,15 @@ export function onSetSeed(): boolean {
   return challenge === Challenge.NULL && customRun;
 }
 
+/**
+ * Helper function to check whether the player is on a Victory Lap (i.e. they answered "yes" to the
+ * popup that happens after defeating The Lamb).
+ */
+export function onVictoryLap(): boolean {
+  const numVictoryLaps = game.GetVictoryLap();
+  return numVictoryLaps > 0;
+}
+
 /**
  * Helper function to restart the run using the console command of "restart". If the player is
  * playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
@@ -100,8 +125,8 @@ export function restart(character?: PlayerType): void {
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *
- * This is useful to revert the behavior where playing on a set and restarting the game will not
- * take you to a new seed.
+ * This is useful to revert the behavior where playing on a set seed and restarting the game will
+ * not take you to a new seed.
  *
  * Under the hood, this function calls the `Seeds.Reset` method and the
  * `Seeds.Restart(Challenge.NULL)` method.