isaacscript-common 3.14.0 → 3.15.0

package/functions/ambush.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Helper function to start a Challenge Room or the Boss Rush.
+ *
+ * Specifically, this is performed by spawning a sack on top of the player, waiting a game frame,
+ * and then removing the sack and the pickups that the sack dropped.
+ */
+export declare function startAmbush(): void;

package/functions/ambush.lua

@@ -0,0 +1,50 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____runInNFrames = require("features.runInNFrames")
+local runNextGameFrame = ____runInNFrames.runNextGameFrame
+local ____entity = require("functions.entity")
+local removeEntities = ____entity.removeEntities
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnPickupWithSeed = ____entitySpecific.spawnPickupWithSeed
+local ____pickups = require("functions.pickups")
+local getCoins = ____pickups.getCoins
+--- Hard-coding this makes it easier to clean up the pickups afterwards.
+local SACK_SEED_THAT_SPAWNS_TWO_COINS = 6
+--- Helper function to start a Challenge Room or the Boss Rush.
+-- 
+-- Specifically, this is performed by spawning a sack on top of the player, waiting a game frame,
+-- and then removing the sack and the pickups that the sack dropped.
+function ____exports.startAmbush(self)
+    local player = Isaac.GetPlayer()
+    local sack = spawnPickupWithSeed(
+        nil,
+        PickupVariant.SACK,
+        0,
+        player.Position,
+        SACK_SEED_THAT_SPAWNS_TWO_COINS
+    )
+    local sprite = sack:GetSprite()
+    sprite:Stop()
+    local sackPtr = EntityPtr(sack)
+    runNextGameFrame(
+        nil,
+        function()
+            local futureSack = sackPtr.Ref
+            if futureSack == nil then
+                return
+            end
+            futureSack:Remove()
+            local sackPtrHash = GetPtrHash(futureSack)
+            local coins = getCoins(nil)
+            local coinsFromSack = __TS__ArrayFilter(
+                coins,
+                function(____, pickup) return GetPtrHash(pickup) == sackPtrHash end
+            )
+            removeEntities(nil, coinsFromSack)
+        end
+    )
+end
+return ____exports

package/index.d.ts

@@ -28,6 +28,7 @@ export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFr
 export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";
 export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
+export * from "./functions/ambush";
 export * from "./functions/array";
 export * from "./functions/benchmark";
 export * from "./functions/bitwise";

package/index.lua

@@ -223,6 +223,14 @@ do
     local getTaintedLazarusSubPlayer = ____taintedLazarusPlayers.getTaintedLazarusSubPlayer
     ____exports.getTaintedLazarusSubPlayer = getTaintedLazarusSubPlayer
 end
+do
+    local ____export = require("functions.ambush")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.array")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

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