isaacscript-common 3.12.0 → 3.15.0

package/callbacks/postDiceRoomActivated.lua

@@ -3,10 +3,10 @@ local hasSubscriptions, postEffectUpdateDiceFloor, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
-local ____constants = require("constants")
-local DICE_FLOOR_TRIGGER_DISTANCE = ____constants.DICE_FLOOR_TRIGGER_DISTANCE
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
+local ____effects = require("functions.effects")
+local isCloseEnoughToTriggerDiceFloor = ____effects.isCloseEnoughToTriggerDiceFloor
 local ____player = require("functions.player")
 local getClosestPlayer = ____player.getClosestPlayer
 local ____postDiceRoomActivated = require("callbacks.subscriptions.postDiceRoomActivated")
@@ -22,9 +22,11 @@ function postEffectUpdateDiceFloor(self, effect)
     if v.room.diceRoomActivated then
         return
     end
+    if effect.FrameCount == 0 then
+        return
+    end
     local closestPlayer = getClosestPlayer(nil, effect.Position)
-    local distance = effect.Position:Distance(closestPlayer.Position)
-    if distance <= DICE_FLOOR_TRIGGER_DISTANCE then
+    if isCloseEnoughToTriggerDiceFloor(nil, closestPlayer, effect) then
         v.room.diceRoomActivated = true
         postDiceRoomActivatedFire(nil, closestPlayer, effect.SubType)
     end

package/constants.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Constants
  */
-import { ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
+import { CollectibleType, ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
 /**
  * The distance of the laser when Azazel does not have any range up items yet. For more info, see
  * the documentation for the `getAzazelBrimstoneDistance` function.
@@ -15,8 +15,6 @@ export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.
 /** Bombs explode when their frame count is equal to this value. */
 export declare const BOMB_EXPLODE_FRAME = 45;
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
-/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76) */
-export declare const DICE_FLOOR_TRIGGER_DISTANCE = 75;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;
 export declare const DOOR_HITBOX_RADIUS = 11;
@@ -36,7 +34,7 @@ export declare const EMPTY_PNG_PATH = "gfx/none.png";
  * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The
  * second TMTRAINER item subtracts one from that, and so on.
  */
-export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
+export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
 export declare const GAME_FRAMES_PER_SECOND = 30;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const ISAAC_FRAMES_PER_SECOND = 60;

package/constants.lua

@@ -19,8 +19,6 @@ ____exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 --- Bombs explode when their frame count is equal to this value.
 ____exports.BOMB_EXPLODE_FRAME = 45
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE
---- For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76)
-____exports.DICE_FLOOR_TRIGGER_DISTANCE = 75
 --- This is also the distance that a player spawns from the door that they enter a room from.
 ____exports.DISTANCE_OF_GRID_TILE = 40
 ____exports.DOOR_HITBOX_RADIUS = 11

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/functions/collectibles.d.ts

@@ -191,6 +191,11 @@ export declare function setCollectibleBlind(collectible: EntityPickup): void;
  * For more information, see the documentation for the "clearSprite" helper function.
  */
 export declare function setCollectibleEmpty(collectible: EntityPickup): void;
+/**
+ * Helper function to change a collectible into a "glitched" item (like the ones that appear when
+ * the player has TMTRAINER).
+ */
+export declare function setCollectibleGlitched(collectible: EntityPickup): void;
 /**
  * Helper function to change the sprite of a collectible pedestal entity.
  *

package/functions/collectibles.lua

@@ -13,6 +13,7 @@ local game = ____cachedClasses.game
 local itemConfig = ____cachedClasses.itemConfig
 local ____constants = require("constants")
 local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
 local ____constantsFirstLast = require("constantsFirstLast")
 local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
 local FIRST_MODDED_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_MODDED_COLLECTIBLE_TYPE
@@ -44,6 +45,22 @@ function initQuestionMarkSprite(self)
     sprite:LoadGraphics()
     return sprite
 end
+function ____exports.clearCollectibleSprite(self, collectible)
+    ____exports.setCollectibleSprite(nil, collectible, nil)
+end
+--- Helper function to remove the collectible from a collectible pedestal and make it appear as if a
+-- player has already taken the item. This is accomplished by changing the sub-type to
+-- `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
+-- 
+-- For more information, see the documentation for the "clearSprite" helper function.
+function ____exports.setCollectibleEmpty(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleEmpty\" function was given a non-collectible: " .. entityID)
+    end
+    collectible.SubType = CollectibleType.NULL
+    ____exports.clearCollectibleSprite(nil, collectible)
+end
 --- Helper function to change the sprite of a collectible pedestal entity.
 -- 
 -- For more information about removing the collectible sprite, see the documentation for the
@@ -67,13 +84,30 @@ function ____exports.setCollectibleSprite(self, collectible, pngPath)
         sprite:LoadGraphics()
     end
 end
+--- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
+-- is not sufficient because the sprite will not change.
+function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleSubType\" function was given a non-collectible: " .. entityID)
+    end
+    if newCollectibleType == CollectibleType.NULL then
+        ____exports.setCollectibleEmpty(nil, collectible)
+        return
+    end
+    collectible:Morph(
+        EntityType.PICKUP,
+        PickupVariant.COLLECTIBLE,
+        newCollectibleType,
+        true,
+        true,
+        true
+    )
+end
 COLLECTIBLE_SPRITE_LAYER = 1
 COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
 local questionMarkSprite = initQuestionMarkSprite(nil)
-function ____exports.clearCollectibleSprite(self, collectible)
-    ____exports.setCollectibleSprite(nil, collectible, nil)
-end
 --- Helper function to check if two collectible sprites have the same sprite sheet loaded.
 function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
     local xStart = -1
@@ -384,38 +418,24 @@ function ____exports.setCollectibleBlind(self, collectible)
     end
     ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
 end
---- Helper function to remove the collectible from a collectible pedestal and make it appear as if a
--- player has already taken the item. This is accomplished by changing the sub-type to
--- `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
--- 
--- For more information, see the documentation for the "clearSprite" helper function.
-function ____exports.setCollectibleEmpty(self, collectible)
+--- Helper function to change a collectible into a "glitched" item (like the ones that appear when
+-- the player has TMTRAINER).
+function ____exports.setCollectibleGlitched(self, collectible)
     if not isCollectible(nil, collectible) then
         local entityID = getEntityID(nil, collectible)
-        error("The \"setCollectibleEmpty\" function was given a non-collectible: " .. entityID)
+        error("The \"setCollectibleGlitched\" function was given a non-collectible: " .. entityID)
     end
-    collectible.SubType = CollectibleType.NULL
-    ____exports.clearCollectibleSprite(nil, collectible)
-end
---- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
--- is not sufficient because the sprite will not change.
-function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
-    if not isCollectible(nil, collectible) then
-        local entityID = getEntityID(nil, collectible)
-        error("The \"setCollectibleSubType\" function was given a non-collectible: " .. entityID)
+    local player = Isaac.GetPlayer()
+    local hasTMTRAINER = player:HasCollectible(CollectibleType.TMTRAINER)
+    if not hasTMTRAINER then
+        player:AddCollectible(CollectibleType.TMTRAINER, 0, false)
     end
-    if newCollectibleType == CollectibleType.NULL then
-        ____exports.setCollectibleEmpty(nil, collectible)
-        return
+    local itemPool = game:GetItemPool()
+    local collectibleType = itemPool:GetCollectible(DEFAULT_ITEM_POOL_TYPE)
+    ____exports.setCollectibleSubType(nil, collectible, collectibleType)
+    if not hasTMTRAINER then
+        player:RemoveCollectible(CollectibleType.TMTRAINER)
     end
-    collectible:Morph(
-        EntityType.PICKUP,
-        PickupVariant.COLLECTIBLE,
-        newCollectibleType,
-        true,
-        true,
-        true
-    )
 end
 --- Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
 -- the build has been rerolled.

package/functions/effects.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76) */
+export declare const DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75;
+/** Helper function to see if a player is close enough to activate a Dice Room floor. */
+export declare function isCloseEnoughToTriggerDiceFloor(player: EntityPlayer, diceFloor: EntityEffect): boolean;

package/functions/effects.lua

@@ -0,0 +1,12 @@
+local ____exports = {}
+local ____math = require("functions.math")
+local inRectangle = ____math.inRectangle
+--- For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76)
+____exports.DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75
+--- Helper function to see if a player is close enough to activate a Dice Room floor.
+function ____exports.isCloseEnoughToTriggerDiceFloor(self, player, diceFloor)
+    local topLeft = diceFloor.Position + Vector(-____exports.DICE_FLOOR_TRIGGER_SQUARE_SIZE, -____exports.DICE_FLOOR_TRIGGER_SQUARE_SIZE)
+    local bottomRight = diceFloor.Position + Vector(____exports.DICE_FLOOR_TRIGGER_SQUARE_SIZE, ____exports.DICE_FLOOR_TRIGGER_SQUARE_SIZE)
+    return inRectangle(nil, player.Position, topLeft, bottomRight)
+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";
@@ -51,6 +52,7 @@ export * from "./functions/direction";
 export * from "./functions/doors";
 export * from "./functions/easing";
 export * from "./functions/eden";
+export * from "./functions/effects";
 export * from "./functions/entity";
 export * from "./functions/entitySpecific";
 export * from "./functions/entityTypes";

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
@@ -401,6 +409,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.effects")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.entity")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

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