isaacscript-common 7.5.1 → 7.6.2

package/dist/features/customGridEntity.d.ts

@@ -28,8 +28,11 @@ export declare function customGridEntityInit(mod: ModUpgraded): void;
  * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
  *                            entity at. If a position is specified, the closest grid index will be
  *                            used.
- * @param gridCollisionClass The collision class that you want the custom grid entity to have.
- * @param anm2Path The path to the ANM2 file to use for the sprite.
+ * @param gridCollisionClass Optional. The collision class that you want the custom grid entity to
+ *                           have. If not specified, the grid collision class from the base grid
+ *                           entity will be used.
+ * @param anm2Path Optional. The path to the ANM2 file to use for the sprite. If not specified, the
+ *                 normal sprite from the base grid entity will be used.
  * @param defaultAnimation Optional. The name of the animation to play after the sprite is
  *                         initialized and after the player re-enters a room with this grid entity
  *                         in it. If not specified, the default animation in the anm2 will be used.
@@ -38,7 +41,7 @@ export declare function customGridEntityInit(mod: ModUpgraded): void;
  * @param baseGridEntityVariant Optional. The variant of the grid entity to use as a "base" for this
  *                              custom grid entity. Default is 0.
  */
-export declare function spawnCustomGridEntity(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, gridCollisionClass: GridCollisionClass, anm2Path: string, defaultAnimation?: string, baseGridEntityType?: GridEntityType, baseGridEntityVariant?: number): GridEntity;
+export declare function spawnCustomGridEntity(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, gridCollisionClass?: GridCollisionClass, anm2Path?: string, defaultAnimation?: string, baseGridEntityType?: GridEntityType, baseGridEntityVariant?: number): GridEntity;
 /**
  * Helper function to remove a custom grid entity created by the `spawnCustomGrid` function.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"customGridEntity.d.ts","sourceRoot":"","sources":["../../src/features/customGridEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,kBAAkB,EAClB,cAAc,EAGf,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAerD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAoB1E,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAmB3D;AAkID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,qBAAqB,CACnC,oBAAoB,EAAE,cAAc,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,kBAAkB,EAAE,kBAAkB,EACtC,QAAQ,EAAE,MAAM,EAChB,gBAAgB,CAAC,EAAE,MAAM,EACzB,kBAAkB,iBAA4B,EAC9C,qBAAqB,SAAI,GACxB,UAAU,CAyCZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACpC,+BAA+B,EAAE,GAAG,GAAG,MAAM,GAAG,UAAU,EAC1D,UAAU,UAAO,GAChB,UAAU,GAAG,SAAS,CAuCxB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,KAAK,CAC5C;IAAC,UAAU,EAAE,UAAU;IAAE,IAAI,EAAE,oBAAoB;CAAC,CACrD,CAqBA;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,cAAc,GAAG,SAAS,CAsB5B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,OAAO,CAOT"}
+{"version":3,"file":"customGridEntity.d.ts","sourceRoot":"","sources":["../../src/features/customGridEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,kBAAkB,EAClB,cAAc,EAGf,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAerD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAoB1E,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAmB3D;AAoID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,qBAAqB,CACnC,oBAAoB,EAAE,cAAc,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,QAAQ,CAAC,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,MAAM,EACzB,kBAAkB,iBAA4B,EAC9C,qBAAqB,SAAI,GACxB,UAAU,CA8CZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACpC,+BAA+B,EAAE,GAAG,GAAG,MAAM,GAAG,UAAU,EAC1D,UAAU,UAAO,GAChB,UAAU,GAAG,SAAS,CAuCxB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,KAAK,CAC5C;IAAC,UAAU,EAAE,UAAU;IAAE,IAAI,EAAE,oBAAoB;CAAC,CACrD,CAqBA;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,cAAc,GAAG,SAAS,CAsB5B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,OAAO,CAOT"}

package/dist/features/customGridEntity.lua

@@ -115,10 +115,12 @@ function postNewRoomReordered(self)
                 roomCustomGridEntities:delete(gridIndex)
                 goto __continue19
             end
-            local sprite = decoration:GetSprite()
-            sprite:Load(data.anm2Path, true)
-            local animationToPlay = data.defaultAnimation == nil and sprite:GetDefaultAnimation() or data.defaultAnimation
-            sprite:Play(animationToPlay, true)
+            if data.anm2Path ~= nil then
+                local sprite = decoration:GetSprite()
+                sprite:Load(data.anm2Path, true)
+                local animationToPlay = data.defaultAnimation == nil and sprite:GetDefaultAnimation() or data.defaultAnimation
+                sprite:Play(animationToPlay, true)
+            end
         end
         ::__continue19::
     end
@@ -165,8 +167,11 @@ end
 -- @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
 -- entity at. If a position is specified, the closest grid index will be
 -- used.
--- @param gridCollisionClass The collision class that you want the custom grid entity to have.
--- @param anm2Path The path to the ANM2 file to use for the sprite.
+-- @param gridCollisionClass Optional. The collision class that you want the custom grid entity to
+-- have. If not specified, the grid collision class from the base grid
+-- entity will be used.
+-- @param anm2Path Optional. The path to the ANM2 file to use for the sprite. If not specified, the
+-- normal sprite from the base grid entity will be used.
 -- @param defaultAnimation Optional. The name of the animation to play after the sprite is
 -- initialized and after the player re-enters a room with this grid entity
 -- in it. If not specified, the default animation in the anm2 will be used.
@@ -189,11 +194,15 @@ function ____exports.spawnCustomGridEntity(self, gridEntityTypeCustom, gridIndex
     if customGridEntity == nil then
         error("Failed to spawn a custom grid entity.")
     end
-    customGridEntity.CollisionClass = gridCollisionClass
-    local sprite = customGridEntity:GetSprite()
-    sprite:Load(anm2Path, true)
-    local animationToPlay = defaultAnimation == nil and sprite:GetDefaultAnimation() or defaultAnimation
-    sprite:Play(animationToPlay, true)
+    if gridCollisionClass ~= nil then
+        customGridEntity.CollisionClass = gridCollisionClass
+    end
+    if anm2Path ~= nil then
+        local sprite = customGridEntity:GetSprite()
+        sprite:Load(anm2Path, true)
+        local animationToPlay = defaultAnimation == nil and sprite:GetDefaultAnimation() or defaultAnimation
+        sprite:Play(animationToPlay, true)
+    end
     local customGridEntityData = {
         gridEntityTypeCustom = gridEntityTypeCustom,
         roomListIndex = roomListIndex,

package/dist/features/customStage/customStageConstants.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+export declare const CUSTOM_STAGE_FEATURE_NAME = "customStage";
 export declare const ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage";
 /** Corresponds to "ui_streak.anm2". */
 export declare enum UIStreakAnimation {

package/dist/features/customStage/customStageConstants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customStageConstants.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/customStageConstants.ts"],"names":[],"mappings":";AAAA,eAAO,MAAM,iCAAiC,iCAAiC,CAAC;AAEhF,uCAAuC;AACvC,oBAAY,iBAAiB;IAC3B,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,SAAS,IAAA;CACV;AAED,uCAAuC;AACvC,eAAO,MAAM,8BAA8B,EAAE;IAC3C,QAAQ,EAAE,GAAG,IAAI,iBAAiB,GAAG,GAAG;CAKhC,CAAC"}
+{"version":3,"file":"customStageConstants.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/customStageConstants.ts"],"names":[],"mappings":";AAAA,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AAEvD,eAAO,MAAM,iCAAiC,iCAAiC,CAAC;AAEhF,uCAAuC;AACvC,oBAAY,iBAAiB;IAC3B,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,SAAS,IAAA;CACV;AAED,uCAAuC;AACvC,eAAO,MAAM,8BAA8B,EAAE;IAC3C,QAAQ,EAAE,GAAG,IAAI,iBAAiB,GAAG,GAAG;CAKhC,CAAC"}

package/dist/features/customStage/customStageConstants.lua

@@ -1,4 +1,5 @@
 local ____exports = {}
+____exports.CUSTOM_STAGE_FEATURE_NAME = "customStage"
 ____exports.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage"
 --- Corresponds to "ui_streak.anm2".
 ____exports.UIStreakAnimation = {}

package/dist/features/customStage/customStageGridEntities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customStageGridEntities.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/customStageGridEntities.ts"],"names":[],"mappings":";AAiBA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAOnE,0CAA0C;AAC1C,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAuBN;AAED,oCAAoC;AACpC,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAyBN;AAED,mCAAmC;AACnC,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAsBN;AAED,mCAAmC;AACnC,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAuBN;AAuDD,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAsBN;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAsBN"}
+{"version":3,"file":"customStageGridEntities.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/customStageGridEntities.ts"],"names":[],"mappings":";AAiBA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AASnE,0CAA0C;AAC1C,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAuBN;AAED,oCAAoC;AACpC,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAyBN;AAED,mCAAmC;AACnC,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAsBN;AAED,mCAAmC;AACnC,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAuBN;AAuDD,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAwBN;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,UAAU,GACrB,IAAI,CAsBN"}

package/dist/features/customStage/customStageGridEntities.lua

@@ -25,6 +25,7 @@ local ____customGridEntity = require("features.customGridEntity")
 local isCustomGridEntity = ____customGridEntity.isCustomGridEntity
 local ____exports = require("features.customTrapdoor.exports")
 local spawnCustomTrapdoor = ____exports.spawnCustomTrapdoor
+local spawnCustomTrapdoorToVanilla = ____exports.spawnCustomTrapdoorToVanilla
 local ____exports = require("features.customStage.exports")
 local DEFAULT_BASE_STAGE = ____exports.DEFAULT_BASE_STAGE
 local ____v = require("features.customStage.v")
@@ -238,11 +239,14 @@ function ____exports.convertVanillaTrapdoors(self, customStage, gridEntity)
         return
     end
     removeGridEntity(nil, gridEntity, true)
-    local baseStage = customStage.baseStage == nil and DEFAULT_BASE_STAGE or customStage.baseStage
-    local vanillaNextStage = baseStage + 2
-    local vanillaNextStageType = calculateStageType(nil, vanillaNextStage)
-    local destination = v.run.firstFloor and ({customStage.name, 2}) or ({vanillaNextStage, vanillaNextStageType})
-    spawnCustomTrapdoor(nil, gridEntity.Position, destination)
+    if v.run.firstFloor then
+        spawnCustomTrapdoor(nil, gridEntity.Position, customStage.name, 2)
+    else
+        local baseStage = customStage.baseStage == nil and DEFAULT_BASE_STAGE or customStage.baseStage
+        local stage = baseStage + 2
+        local stageType = calculateStageType(nil, stage)
+        spawnCustomTrapdoorToVanilla(nil, gridEntity.Position, stage, stageType)
+    end
 end
 --- The rewards are based on the ones from the wiki:
 -- https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Urns

package/dist/features/customStage/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/init.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AA6BxD,wBAAgB,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CA0BtD"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/init.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AA8BxD,wBAAgB,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CA0BtD"}

package/dist/features/customStage/init.lua

@@ -19,6 +19,8 @@ local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____backdrop = require("features.customStage.backdrop")
 local setCustomStageBackdrop = ____backdrop.setCustomStageBackdrop
+local ____customStageConstants = require("features.customStage.customStageConstants")
+local CUSTOM_STAGE_FEATURE_NAME = ____customStageConstants.CUSTOM_STAGE_FEATURE_NAME
 local ____customStageGridEntities = require("features.customStage.customStageGridEntities")
 local convertVanillaTrapdoors = ____customStageGridEntities.convertVanillaTrapdoors
 local removeUrnRewards = ____customStageGridEntities.removeUrnRewards
@@ -133,7 +135,7 @@ function ____exports.customStageInit(self, mod)
     if customStagesMap.size == 0 then
         return
     end
-    saveDataManager(nil, "customStage", v)
+    saveDataManager(nil, CUSTOM_STAGE_FEATURE_NAME, v)
     versusScreenInit(nil)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
     mod:AddCallback(ModCallback.POST_CURSE_EVAL, postCurseEval)

package/dist/features/customStage/versusScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versusScreen.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/versusScreen.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AA2EnE;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAavC;AAED,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CA2ExE;AAkGD,wBAAgB,sBAAsB,IAAI,IAAI,CAkC7C"}
+{"version":3,"file":"versusScreen.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/versusScreen.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AA+EnE;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAavC;AAED,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CA4ExE;AAmGD,wBAAgB,sBAAsB,IAAI,IAAI,CAkC7C"}

package/dist/features/customStage/versusScreen.lua

@@ -33,12 +33,16 @@ local ____versusScreenBackgroundColors = require("objects.versusScreenBackground
 local VERSUS_SCREEN_BACKGROUND_COLORS = ____versusScreenBackgroundColors.VERSUS_SCREEN_BACKGROUND_COLORS
 local ____versusScreenDirtSpotColors = require("objects.versusScreenDirtSpotColors")
 local VERSUS_SCREEN_DIRT_SPOT_COLORS = ____versusScreenDirtSpotColors.VERSUS_SCREEN_DIRT_SPOT_COLORS
+local ____disableAllSound = require("features.disableAllSound")
+local disableAllSound = ____disableAllSound.disableAllSound
+local enableAllSound = ____disableAllSound.enableAllSound
 local ____pause = require("features.pause")
 local pause = ____pause.pause
 local unpause = ____pause.unpause
 local ____runInNFrames = require("features.runInNFrames")
 local runNextGameFrame = ____runInNFrames.runNextGameFrame
 local ____customStageConstants = require("features.customStage.customStageConstants")
+local CUSTOM_STAGE_FEATURE_NAME = ____customStageConstants.CUSTOM_STAGE_FEATURE_NAME
 local ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = ____customStageConstants.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH
 local ____exports = require("features.customStage.exports")
 local DEFAULT_BASE_STAGE = ____exports.DEFAULT_BASE_STAGE
@@ -174,6 +178,7 @@ function ____exports.playVersusScreenAnimation(self, customStage)
     v.run.showingBossVersusScreen = true
     pause(nil)
     hud:SetVisible(false)
+    disableAllSound(nil, CUSTOM_STAGE_FEATURE_NAME)
     do
         local ____getPlayerPNGPaths_result_0 = getPlayerPNGPaths(nil)
         local namePNGPath = ____getPlayerPNGPaths_result_0.namePNGPath
@@ -226,6 +231,7 @@ local function finishVersusScreenAnimation(self)
     v.run.showingBossVersusScreen = false
     unpause(nil)
     hud:SetVisible(true)
+    enableAllSound(nil, CUSTOM_STAGE_FEATURE_NAME)
     sfxManager:Play(SoundEffect.CASTLE_PORTCULLIS)
 end
 function ____exports.versusScreenPostRender(self)

package/dist/features/customTrapdoor/exports.d.ts

@@ -1,33 +1,45 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-import { TrapdoorDestination } from "../../types/TrapdoorDestination";
+import { LevelStage, StageType } from "isaac-typescript-definitions";
 /**
- * Helper function to spawn a trapdoor grid entity that will have one or more of the following
- * attributes:
+ * Helper function to spawn a trapdoor grid entity that will take a player to a custom stage. If you
+ * want to create a custom trapdoor that goes to a vanilla stage instead, use the
+ * `spawnCustomTrapdoorToVanilla` helper function.
+ *
+ * Custom trapdoors can have one or more of the following attributes:
  *
  * - custom destination (or custom logic for after the player enters)
  * - custom graphics
  * - custom logic for opening/closing
  *
- * You can use this function to take the player to your custom stage.
- *
  * Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
  * respawned every time the player re-enters the room.
  *
  * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
- * @param destination Optional. Used to specify where the player will go after jumping into the
- *                    trapdoor. Can either be a vanilla stage tuple, a custom stage tuple, or
- *                    undefined. For example, a destination of `[LevelStage.CAVES_1,
- *                    StageType.ORIGINAL]` corresponds to Caves 1, and a destination of
- *                    `["Slaughterhouse", 1]` corresponds to a custom stage of Slaughterhouse 1. If
- *                    the destination is undefined, then the "normal" destination corresponding to
- *                    the current stage and room will be used (e.g. the next floor, in most cases).
+ * @param customStageName The name of the custom stage.
+ * @param customStageFloorNum The floor of the custom stage. For most purposes, you should use 1 or
+ *                            2.
+ * @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2
+ *                 of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file must
+ *                 have animations called "Opened", "Closed", and "Open Animation".
+ * @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
+ *                  behavior will be used that emulates a vanilla trapdoor.
+ */
+export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, customStageName: string, customStageFloorNum: int, anm2Path?: string, spawnOpen?: boolean): GridEntity;
+/**
+ * This is the same thing as the `spawnCustomTrapdoor` function, but instead of having a destination
+ * of a custom stage, it has a destination of a vanilla stage.
+ *
+ * For more information, see the `spawnCustomTrapdoor` function.
+ *
+ * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
+ * @param stage Optional. The number of the vanilla stage to go to. If not provided, the "normal"
+ *              next stage will be selected.
+ * @param stageType The stage type of the vanilla stage to go to. If not provided, the "normal" next
+ *                  stage type will be selected.
  * @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2
  *                 of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file must
  *                 have animations called "Opened", "Closed", and "Open Animation".
  * @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
  *                  behavior will be used that emulates a vanilla trapdoor.
  */
-export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, destination?: TrapdoorDestination, anm2Path?: string, spawnOpen?: boolean): GridEntity;
+export declare function spawnCustomTrapdoorToVanilla(gridIndexOrPosition: int | Vector, stage?: LevelStage, stageType?: StageType, anm2Path?: string, spawnOpen?: boolean): GridEntity;
 //# sourceMappingURL=exports.d.ts.map

package/dist/features/customTrapdoor/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/exports.ts"],"names":[],"mappings":";;;AAYA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAStE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mBAAmB,CACjC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,WAAW,CAAC,EAAE,mBAAmB,EACjC,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU,CAwCZ"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAOrE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,mBAAmB,CACjC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,eAAe,EAAE,MAAM,EACvB,mBAAmB,EAAE,GAAG,EACxB,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU,CAcZ;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAC1C,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,EACrB,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU,CAkBZ"}

package/dist/features/customTrapdoor/exports.lua

@@ -1,94 +1,78 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
 local ____exports = {}
-local getDefaultDestination
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local GridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.GridCollisionClass
-local ____cachedClasses = require("core.cachedClasses")
-local game = ____cachedClasses.game
-local ____TrapdoorAnimation = require("enums.private.TrapdoorAnimation")
-local TrapdoorAnimation = ____TrapdoorAnimation.TrapdoorAnimation
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____nextStage = require("functions.nextStage")
 local getNextStage = ____nextStage.getNextStage
 local getNextStageType = ____nextStage.getNextStageType
-local ____roomData = require("functions.roomData")
-local getRoomListIndex = ____roomData.getRoomListIndex
-local ____vector = require("functions.vector")
-local isVector = ____vector.isVector
-local ____customGridEntity = require("features.customGridEntity")
-local spawnCustomGridEntity = ____customGridEntity.spawnCustomGridEntity
 local ____customTrapdoorConstants = require("features.customTrapdoor.customTrapdoorConstants")
 local CUSTOM_TRAPDOOR_FEATURE_NAME = ____customTrapdoorConstants.CUSTOM_TRAPDOOR_FEATURE_NAME
-local GridEntityTypeCustom = ____customTrapdoorConstants.GridEntityTypeCustom
-local ____openClose = require("features.customTrapdoor.openClose")
-local shouldTrapdoorSpawnOpen = ____openClose.shouldTrapdoorSpawnOpen
-local ____v = require("features.customTrapdoor.v")
-local v = ____v.default
-function getDefaultDestination(self)
-    local nextStage = getNextStage(nil)
-    local nextStageType = getNextStageType(nil)
-    return {nextStage, nextStageType}
-end
---- Helper function to spawn a trapdoor grid entity that will have one or more of the following
--- attributes:
+local ____spawn = require("features.customTrapdoor.spawn")
+local spawnCustomTrapdoorToDestination = ____spawn.spawnCustomTrapdoorToDestination
+--- Helper function to spawn a trapdoor grid entity that will take a player to a custom stage. If you
+-- want to create a custom trapdoor that goes to a vanilla stage instead, use the
+-- `spawnCustomTrapdoorToVanilla` helper function.
+-- 
+-- Custom trapdoors can have one or more of the following attributes:
 -- 
 -- - custom destination (or custom logic for after the player enters)
 -- - custom graphics
 -- - custom logic for opening/closing
 -- 
--- You can use this function to take the player to your custom stage.
--- 
 -- Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
 -- respawned every time the player re-enters the room.
 -- 
 -- @param gridIndexOrPosition The location in the room to spawn the trapdoor.
--- @param destination Optional. Used to specify where the player will go after jumping into the
--- trapdoor. Can either be a vanilla stage tuple, a custom stage tuple, or
--- undefined. For example, a destination of `[LevelStage.CAVES_1,
--- StageType.ORIGINAL]` corresponds to Caves 1, and a destination of
--- `["Slaughterhouse", 1]` corresponds to a custom stage of Slaughterhouse 1. If
--- the destination is undefined, then the "normal" destination corresponding to
--- the current stage and room will be used (e.g. the next floor, in most cases).
+-- @param customStageName The name of the custom stage.
+-- @param customStageFloorNum The floor of the custom stage. For most purposes, you should use 1 or
+-- 2.
 -- @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2
 -- of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file must
 -- have animations called "Opened", "Closed", and "Open Animation".
 -- @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
 -- behavior will be used that emulates a vanilla trapdoor.
-function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, destination, anm2Path, spawnOpen)
+function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, customStageName, customStageFloorNum, anm2Path, spawnOpen)
     if anm2Path == nil then
         anm2Path = "gfx/grid/door_11_trapdoor.anm2"
     end
     errorIfFeaturesNotInitialized(nil, CUSTOM_TRAPDOOR_FEATURE_NAME)
-    local room = game:GetRoom()
-    local roomFrameCount = room:GetFrameCount()
-    local roomListIndex = getRoomListIndex(nil)
-    local gridIndex = isVector(nil, gridIndexOrPosition) and room:GetGridIndex(gridIndexOrPosition) or gridIndexOrPosition
-    local gridEntity = spawnCustomGridEntity(
+    local destination = {customStageName = customStageName, customStageFloorNum = customStageFloorNum}
+    return spawnCustomTrapdoorToDestination(
         nil,
-        GridEntityTypeCustom.TRAPDOOR_CUSTOM,
         gridIndexOrPosition,
-        GridCollisionClass.NONE,
+        destination,
         anm2Path,
-        TrapdoorAnimation.OPENED
+        spawnOpen
     )
-    local firstSpawn = roomFrameCount ~= 0
-    local ____temp_0
-    if spawnOpen == nil then
-        ____temp_0 = shouldTrapdoorSpawnOpen(nil, gridEntity, firstSpawn)
-    else
-        ____temp_0 = spawnOpen
-    end
-    local open = ____temp_0
-    local destinationToUse = destination == nil and getDefaultDestination(nil) or destination
-    local roomTrapdoorMap = v.level.trapdoors:getAndSetDefault(roomListIndex)
-    local customTrapdoorDescription = {open = open, destination = destinationToUse, firstSpawn = firstSpawn}
-    roomTrapdoorMap:set(gridIndex, customTrapdoorDescription)
-    if not open then
-        local sprite = gridEntity:GetSprite()
-        sprite:Play(TrapdoorAnimation.CLOSED, true)
+end
+--- This is the same thing as the `spawnCustomTrapdoor` function, but instead of having a destination
+-- of a custom stage, it has a destination of a vanilla stage.
+-- 
+-- For more information, see the `spawnCustomTrapdoor` function.
+-- 
+-- @param gridIndexOrPosition The location in the room to spawn the trapdoor.
+-- @param stage Optional. The number of the vanilla stage to go to. If not provided, the "normal"
+-- next stage will be selected.
+-- @param stageType The stage type of the vanilla stage to go to. If not provided, the "normal" next
+-- stage type will be selected.
+-- @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2
+-- of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file must
+-- have animations called "Opened", "Closed", and "Open Animation".
+-- @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
+-- behavior will be used that emulates a vanilla trapdoor.
+function ____exports.spawnCustomTrapdoorToVanilla(self, gridIndexOrPosition, stage, stageType, anm2Path, spawnOpen)
+    if anm2Path == nil then
+        anm2Path = "gfx/grid/door_11_trapdoor.anm2"
     end
-    return gridEntity
+    errorIfFeaturesNotInitialized(nil, CUSTOM_TRAPDOOR_FEATURE_NAME)
+    local vanillaStage = stage == nil and getNextStage(nil) or stage
+    local vanillaStageType = stageType == nil and getNextStageType(nil) or stageType
+    local destination = {vanillaStage = vanillaStage, vanillaStageType = vanillaStageType}
+    return spawnCustomTrapdoorToDestination(
+        nil,
+        gridIndexOrPosition,
+        destination,
+        anm2Path,
+        spawnOpen
+    )
 end
 return ____exports

package/dist/features/customTrapdoor/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/init.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AA0BxD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAUzD"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/init.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAyBxD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAUzD"}

package/dist/features/customTrapdoor/init.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local Map = ____lualib.Map
 local ____exports = {}
-local postRender, checkAllPlayersJumpComplete, checkPixelationToBlackComplete, checkSecondPixelationHalfWay, checkAllPlayersLayingDownComplete, goToCustomDestination, anyPlayerPlayingExtraAnimation, postPEffectUpdate, checkJumpComplete, postGridEntityCustomUpdateTrapdoor
+local postRender, checkAllPlayersJumpComplete, checkPixelationToBlackComplete, checkSecondPixelationHalfWay, checkAllPlayersLayingDownComplete, goToCustomTrapdoorDestination, anyPlayerPlayingExtraAnimation, postPEffectUpdate, checkJumpComplete, postGridEntityCustomUpdateTrapdoor
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
@@ -26,8 +26,6 @@ local ____roomTransition = require("functions.roomTransition")
 local teleport = ____roomTransition.teleport
 local ____stage = require("functions.stage")
 local setStage = ____stage.setStage
-local ____types = require("functions.types")
-local isString = ____types.isString
 local ____exports = require("features.customStage.exports")
 local disableCustomStage = ____exports.disableCustomStage
 local setCustomStage = ____exports.setCustomStage
@@ -93,7 +91,7 @@ function checkPixelationToBlackComplete(self)
             local futureRenderFrameCount = Isaac.GetFrameCount()
             v.run.state = StageTravelState.WAITING_FOR_SECOND_PIXELATION_TO_GET_HALF_WAY
             v.run.stateRenderFrame = futureRenderFrameCount
-            goToCustomDestination(nil)
+            goToCustomTrapdoorDestination(nil)
             teleport(
                 nil,
                 startingRoomIndex,
@@ -145,17 +143,21 @@ function checkAllPlayersLayingDownComplete(self)
     v.run.state = StageTravelState.NONE
     enableAllInputs(nil, CUSTOM_TRAPDOOR_FEATURE_NAME)
 end
-function goToCustomDestination(self)
+function goToCustomTrapdoorDestination(self)
     if v.run.destination == nil then
         return
     end
-    local arg1, arg2 = table.unpack(v.run.destination)
-    if isString(nil, arg1) then
-        local firstFloor = arg2 == 1
+    local ____v_run_destination_0 = v.run.destination
+    local customStageName = ____v_run_destination_0.customStageName
+    local customStageFloorNum = ____v_run_destination_0.customStageFloorNum
+    local vanillaStage = ____v_run_destination_0.vanillaStage
+    local vanillaStageType = ____v_run_destination_0.vanillaStageType
+    if customStageName ~= nil and customStageFloorNum ~= nil then
+        local firstFloor = customStageFloorNum == 1
         setCustomStage(nil, "Slaughterhouse", firstFloor)
-    else
+    elseif vanillaStage ~= nil and vanillaStageType ~= nil then
         disableCustomStage(nil)
-        setStage(nil, arg1, arg2)
+        setStage(nil, vanillaStage, vanillaStageType)
     end
 end
 function anyPlayerPlayingExtraAnimation(self)

package/dist/features/customTrapdoor/spawn.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { CustomTrapdoorDestination } from "../../interfaces/private/CustomTrapdoorDestination";
+export declare function spawnCustomTrapdoorToDestination(gridIndexOrPosition: int | Vector, destination: CustomTrapdoorDestination, anm2Path: string, spawnOpen?: boolean): GridEntity;
+//# sourceMappingURL=spawn.d.ts.map

package/dist/features/customTrapdoor/spawn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spawn.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/spawn.ts"],"names":[],"mappings":";;;AAMA,OAAO,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAM/F,wBAAgB,gCAAgC,CAC9C,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,WAAW,EAAE,yBAAyB,EACtC,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU,CAmCZ"}

package/dist/features/customTrapdoor/spawn.lua

@@ -0,0 +1,51 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.GridCollisionClass
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____TrapdoorAnimation = require("enums.private.TrapdoorAnimation")
+local TrapdoorAnimation = ____TrapdoorAnimation.TrapdoorAnimation
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
+local ____customGridEntity = require("features.customGridEntity")
+local spawnCustomGridEntity = ____customGridEntity.spawnCustomGridEntity
+local ____customTrapdoorConstants = require("features.customTrapdoor.customTrapdoorConstants")
+local GridEntityTypeCustom = ____customTrapdoorConstants.GridEntityTypeCustom
+local ____openClose = require("features.customTrapdoor.openClose")
+local shouldTrapdoorSpawnOpen = ____openClose.shouldTrapdoorSpawnOpen
+local ____v = require("features.customTrapdoor.v")
+local v = ____v.default
+function ____exports.spawnCustomTrapdoorToDestination(self, gridIndexOrPosition, destination, anm2Path, spawnOpen)
+    local room = game:GetRoom()
+    local roomFrameCount = room:GetFrameCount()
+    local roomListIndex = getRoomListIndex(nil)
+    local gridIndex = isVector(nil, gridIndexOrPosition) and room:GetGridIndex(gridIndexOrPosition) or gridIndexOrPosition
+    local gridEntity = spawnCustomGridEntity(
+        nil,
+        GridEntityTypeCustom.TRAPDOOR_CUSTOM,
+        gridIndexOrPosition,
+        GridCollisionClass.NONE,
+        anm2Path,
+        TrapdoorAnimation.OPENED
+    )
+    local firstSpawn = roomFrameCount ~= 0
+    local ____temp_0
+    if spawnOpen == nil then
+        ____temp_0 = shouldTrapdoorSpawnOpen(nil, gridEntity, firstSpawn)
+    else
+        ____temp_0 = spawnOpen
+    end
+    local open = ____temp_0
+    local roomTrapdoorMap = v.level.trapdoors:getAndSetDefault(roomListIndex)
+    local customTrapdoorDescription = {open = open, destination = destination, firstSpawn = firstSpawn}
+    roomTrapdoorMap:set(gridIndex, customTrapdoorDescription)
+    local sprite = gridEntity:GetSprite()
+    local animation = open and TrapdoorAnimation.OPENED or TrapdoorAnimation.CLOSED
+    sprite:Play(animation, true)
+    return gridEntity
+end
+return ____exports

package/dist/features/customTrapdoor/v.d.ts

@@ -1,13 +1,13 @@
 import { DefaultMap } from "../../classes/DefaultMap";
 import { StageTravelState } from "../../enums/private/StageTravelState";
 import { CustomTrapdoorDescription } from "../../interfaces/private/CustomTrapdoorDescription";
-import { TrapdoorDestination } from "../../types/TrapdoorDestination";
+import { CustomTrapdoorDestination } from "../../interfaces/private/CustomTrapdoorDestination";
 declare const v: {
     run: {
         state: StageTravelState;
         /** The render frame that this state was reached. */
         stateRenderFrame: number | null;
-        destination: TrapdoorDestination | null;
+        destination: CustomTrapdoorDestination | null;
     };
     level: {
         /** Indexed by room list index and grid index. */

package/dist/features/customTrapdoor/v.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"v.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/v.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,QAAA,MAAM,CAAC;;;QAIH,oDAAoD;;;;;QAOpD,iDAAiD;;;CAKpD,CAAC;AACF,eAAe,CAAC,CAAC"}
+{"version":3,"file":"v.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/v.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAC/F,OAAO,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAE/F,QAAA,MAAM,CAAC;;;QAIH,oDAAoD;;;;;QAOpD,iDAAiD;;;CAKpD,CAAC;AACF,eAAe,CAAC,CAAC"}