isaacscript-common 4.5.2 → 4.6.0

package/constants.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module core/Constants
- */
 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

package/constantsFirstLast.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Constants (First and Last)
- */
 import { Card, CollectibleType, PillColor, PillEffect, PlayerType, TrinketType } from "isaac-typescript-definitions";
 /** Equal to `CollectibleType.SAD_ONION`. */
 export declare const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;

package/features/characterHealthConversion.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Easily create custom characters that have the same health mechanic as Blue Baby (red heart
+ * containers --> soul hearts) or Black Judas (red heart containers --> black hearts).
+ *
+ * @module
+ */
 import { HeartSubType, PlayerType } from "isaac-typescript-definitions";
 export declare type ConversionHeartSubType = HeartSubType.SOUL | HeartSubType.BLACK;
 /**

package/features/characterStats.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Easily create custom characters that have base stats different from that of Isaac.
+ *
+ * @module
+ */
 import { CacheFlag, PlayerType } from "isaac-typescript-definitions";
 /**
  * Helper function to manage the stats for a vanilla or custom character. Call this function once at

package/features/deployJSONRoom.lua

@@ -37,6 +37,7 @@ local removeAllBombs = ____entitySpecific.removeAllBombs
 local removeAllPickups = ____entitySpecific.removeAllPickups
 local ____gridEntity = require("functions.gridEntity")
 local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
+local getAllGridIndexes = ____gridEntity.getAllGridIndexes
 local getGridEntities = ____gridEntity.getGridEntities
 local removeAllGridExcept = ____gridEntity.removeAllGridExcept
 local removeGrid = ____gridEntity.removeGrid
@@ -59,8 +60,6 @@ local setRoomCleared = ____rooms.setRoomCleared
 local setRoomUncleared = ____rooms.setRoomUncleared
 local ____spawnCollectible = require("functions.spawnCollectible")
 local spawnCollectible = ____spawnCollectible.spawnCollectible
-local ____utils = require("functions.utils")
-local erange = ____utils.erange
 local ____runInNFrames = require("features.runInNFrames")
 local runNextGameFrame = ____runInNFrames.runNextGameFrame
 local ____exports = require("features.saveDataManager.exports")
@@ -182,10 +181,9 @@ function removeSpecificNPCs(self)
 end
 function fillRoomWithDecorations(self)
     local room = game:GetRoom()
-    local gridSize = room:GetGridSize()
     local roomListIndex = getRoomListIndex(nil)
     local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
-    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+    for ____, gridIndex in ipairs(getAllGridIndexes(nil)) do
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then

package/features/disableAllSound.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Disable All Sound
- */
 /**
  * Helper function to stop muting all sound effects and music.
  *

package/functions/gridEntity.d.ts

@@ -5,6 +5,12 @@ import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions"
  * 1000.0 in a room XML file, but `GridEntityType.ROCK` is equal to 2.
  */
 export declare function convertXMLGridEntityType(gridEntityXMLType: GridEntityXMLType, gridEntityXMLVariant: int): [GridEntityType, int] | undefined;
+/**
+ * Helper function to get every legal grid index for the current room.
+ *
+ * Under the hood, this uses the `Room.GetGridSize` method.
+ */
+export declare function getAllGridIndexes(): int[];
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
  * entity is on.
@@ -79,6 +85,9 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * Helper function to all grid entities in the room except for ones matching the grid entity types
  * provided.
  *
+ * Note that this function will automatically update the room. (This means that you can spawn new
+ * grid entities on the same tile on the same frame, if needed.)
+ *
  * For example:
  *
  * ```ts
@@ -95,6 +104,9 @@ export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
  *
+ * Note that this function will automatically update the room. (This means that you can spawn new
+ * grid entities on the same tile on the same frame, if needed.)
+ *
  * For example:
  *
  * ```ts

package/functions/gridEntity.lua

@@ -32,11 +32,18 @@ local ____utils = require("functions.utils")
 local erange = ____utils.erange
 local ____vector = require("functions.vector")
 local isVector = ____vector.isVector
-function getAllGridEntities(self)
+--- Helper function to get every legal grid index for the current room.
+-- 
+-- Under the hood, this uses the `Room.GetGridSize` method.
+function ____exports.getAllGridIndexes(self)
     local room = game:GetRoom()
     local gridSize = room:GetGridSize()
+    return erange(nil, gridSize)
+end
+function getAllGridEntities(self)
+    local room = game:GetRoom()
     local gridEntities = {}
-    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+    for ____, gridIndex in ipairs(____exports.getAllGridIndexes(nil)) do
         local gridEntity = room:GetGridEntity(gridIndex)
         if gridEntity ~= nil then
             gridEntities[#gridEntities + 1] = gridEntity
@@ -277,6 +284,9 @@ end
 --- Helper function to all grid entities in the room except for ones matching the grid entity types
 -- provided.
 -- 
+-- Note that this function will automatically update the room. (This means that you can spawn new
+-- grid entities on the same tile on the same frame, if needed.)
+-- 
 -- For example:
 -- 
 -- ```ts
@@ -307,6 +317,9 @@ end
 --- Helper function to remove all of the grid entities in the room that match the grid entity types
 -- provided.
 -- 
+-- Note that this function will automatically update the room. (This means that you can spawn new
+-- grid entities on the same tile on the same frame, if needed.)
+-- 
 -- For example:
 -- 
 -- ```ts

package/functions/rng.lua

@@ -122,11 +122,16 @@ function ____exports.setAllRNGToSeed(self, object, seed)
     if not isTable(nil, object) then
         error("Failed to iterate over the object containing RNG objects since the type of the provided object was: " .. __TS__TypeOf(object))
     end
+    local setAtLeastOneSeed = false
     for _key, value in pairs(object) do
         if ____exports.isRNG(nil, value) then
             ____exports.setSeed(nil, value, seed)
+            setAtLeastOneSeed = true
         end
     end
+    if not setAtLeastOneSeed then
+        error(("Failed to set all RNG objects to seed " .. tostring(seed)) .. " because the parent object did not contain any RNG objects.")
+    end
 end
 --- Helper function to iterate over the provided object and set the seed for all of the values that
 -- are RNG objects equal to the start seed for the current run.

package/functions/rooms.d.ts

@@ -9,6 +9,7 @@ export declare function changeRoom(roomGridIndex: int): void;
  * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
  */
 export declare function getAllDimensions(): Dimension[];
+/** Helper function to get the grid index for every room on the entire floor. */
 export declare function getAllRoomGridIndexes(): int[];
 /**
  * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,

package/functions/rooms.lua

@@ -123,6 +123,7 @@ end
 function ____exports.getAllDimensions(self)
     return erange(nil, NUM_DIMENSIONS)
 end
+--- Helper function to get the grid index for every room on the entire floor.
 function ____exports.getAllRoomGridIndexes(self)
     local rooms = ____exports.getRooms(nil)
     return __TS__ArrayMap(

package/functions/stage.d.ts

@@ -1,4 +1,4 @@
-import { LevelStage, StageType } from "isaac-typescript-definitions";
+import { LevelStage, RoomType, StageType } from "isaac-typescript-definitions";
 /**
  * Helper function that calculates what the stage type should be for the provided stage. This
  * emulates what the game's internal code does.
@@ -15,6 +15,11 @@ export declare function calculateStageTypeRepentance(stage: LevelStage): StageTy
  * consider Downpour 2 to have a stage of 3.
  */
 export declare function getEffectiveStage(): int;
+/**
+ * Helper function to get the prefix to use with the "goto" console command that would correspond to
+ * the provided room type.
+ */
+export declare function getGotoCommandPrefix(roomType: RoomType): string;
 /** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
 /** Alias for the `Level.GetStageType` method. */

package/functions/stage.lua

@@ -4,6 +4,8 @@ local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____roomTypeGotoPrefixes = require("objects.roomTypeGotoPrefixes")
+local ROOM_TYPE_GOTO_PREFIXES = ____roomTypeGotoPrefixes.ROOM_TYPE_GOTO_PREFIXES
 local ____stageTypeSuffixes = require("objects.stageTypeSuffixes")
 local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
 local ____stageTypeToLetter = require("objects.stageTypeToLetter")
@@ -62,6 +64,11 @@ function ____exports.getEffectiveStage(self)
     end
     return stage
 end
+--- Helper function to get the prefix to use with the "goto" console command that would correspond to
+-- the provided room type.
+function ____exports.getGotoCommandPrefix(self, roomType)
+    return ROOM_TYPE_GOTO_PREFIXES[roomType]
+end
 --- Alias for the `Level.GetStage` method.
 function ____exports.getStage(self)
     local level = game:GetLevel()

package/index.d.ts

@@ -12,7 +12,6 @@ export * from "./enums/SerializationType";
 export { ConversionHeartSubType, registerCharacterHealthConversion, } from "./features/characterHealthConversion";
 export { registerCharacterStats } from "./features/characterStats";
 export { getCollectibleItemPoolType } from "./features/collectibleItemPoolType";
-export * from "./features/customTrapdoor/exports";
 export * from "./features/debugDisplay/exports";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllSound, enableAllSound } from "./features/disableAllSound";

package/index.lua

@@ -100,14 +100,6 @@ do
     local getCollectibleItemPoolType = ____collectibleItemPoolType.getCollectibleItemPoolType
     ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
 end
-do
-    local ____export = require("features.customTrapdoor.exports")
-    for ____exportKey, ____exportValue in pairs(____export) do
-        if ____exportKey ~= "default" then
-            ____exports[____exportKey] = ____exportValue
-        end
-    end
-end
 do
     local ____export = require("features.debugDisplay.exports")
     for ____exportKey, ____exportValue in pairs(____export) do

package/initFeatures.lua

@@ -5,8 +5,6 @@ local ____characterStats = require("features.characterStats")
 local characterStatsInit = ____characterStats.characterStatsInit
 local ____collectibleItemPoolType = require("features.collectibleItemPoolType")
 local collectibleItemPoolTypeInit = ____collectibleItemPoolType.collectibleItemPoolTypeInit
-local ____init = require("features.customTrapdoor.init")
-local stageTravelInit = ____init.stageTravelInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableAllSound = require("features.disableAllSound")
@@ -60,7 +58,6 @@ function ____exports.initFeaturesMinor(self, mod)
     roomClearFrameInit(nil, mod)
     sirenHelpersInit(nil, mod)
     stageHistoryInit(nil, mod)
-    stageTravelInit(nil)
     taintedLazarusPlayersInit(nil, mod)
 end
 return ____exports

package/maps/roomTypeMap.lua

@@ -6,7 +6,6 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 --- Maps room type names to room types.
 ____exports.ROOM_TYPE_MAP = __TS__New(Map, {
-    {"null", RoomType.NULL},
     {"default", RoomType.DEFAULT},
     {"shop", RoomType.SHOP},
     {"error", RoomType.ERROR},

package/objects/roomTypeGotoPrefixes.d.ts

@@ -0,0 +1,4 @@
+import { RoomType } from "isaac-typescript-definitions";
+export declare const ROOM_TYPE_GOTO_PREFIXES: {
+    readonly [key in RoomType]: string;
+};

package/objects/roomTypeGotoPrefixes.lua

@@ -0,0 +1,35 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+____exports.ROOM_TYPE_GOTO_PREFIXES = {
+    [RoomType.DEFAULT] = "d.",
+    [RoomType.SHOP] = "s.shop.",
+    [RoomType.ERROR] = "s.error.",
+    [RoomType.TREASURE] = "s.treasure.",
+    [RoomType.BOSS] = "s.boss.",
+    [RoomType.MINI_BOSS] = "s.miniboss.",
+    [RoomType.SECRET] = "s.secret.",
+    [RoomType.SUPER_SECRET] = "s.supersecret.",
+    [RoomType.ARCADE] = "s.arcade.",
+    [RoomType.CURSE] = "s.curse.",
+    [RoomType.CHALLENGE] = "s.challenge.",
+    [RoomType.LIBRARY] = "s.library.",
+    [RoomType.SACRIFICE] = "s.sacrifice.",
+    [RoomType.DEVIL] = "s.devil.",
+    [RoomType.ANGEL] = "s.angel.",
+    [RoomType.DUNGEON] = "s.itemdungeon.",
+    [RoomType.BOSS_RUSH] = "s.bossrush.",
+    [RoomType.CLEAN_BEDROOM] = "s.isaacs.",
+    [RoomType.DIRTY_BEDROOM] = "s.barren.",
+    [RoomType.CHEST] = "s.chest.",
+    [RoomType.DICE] = "s.dice.",
+    [RoomType.BLACK_MARKET] = "s.blackmarket.",
+    [RoomType.GREED_EXIT] = "s.greedexit.",
+    [RoomType.PLANETARIUM] = "s.planetarium.",
+    [RoomType.TELEPORTER] = "s.teleporter.",
+    [RoomType.TELEPORTER_EXIT] = "s.teleporterexit.",
+    [RoomType.SECRET_EXIT] = "s.secretexit.",
+    [RoomType.BLUE] = "s.blue.",
+    [RoomType.ULTRA_SECRET] = "s.ultrasecret."
+}
+return ____exports

package/objects/roomTypeNames.lua

@@ -3,7 +3,6 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 ____exports.DEFAULT_ROOM_TYPE_NAME = "Unknown"
 ____exports.ROOM_TYPE_NAMES = {
-    [RoomType.NULL] = "null room",
     [RoomType.DEFAULT] = "default room",
     [RoomType.SHOP] = "shop",
     [RoomType.ERROR] = "I AM ERROR Room",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.13"
+    "isaac-typescript-definitions": "^3.0.14"
   }
 }

package/types/PickingUpItem.d.ts

@@ -27,8 +27,8 @@ export interface PickingUpItemTrinket {
     subType: TrinketType;
 }
 /** Helper function to narrow the type of `PickingUpItem`. */
-export declare function pickingUpItemIsNull(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;
+export declare function isPickingUpItemNull(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;
 /** Helper function to narrow the type of `PickingUpItem`. */
-export declare function pickingUpItemIsCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
+export declare function isPickingUpItemCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
 /** Helper function to narrow the type of `PickingUpItem`. */
-export declare function pickingUpItemIsTrinket(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;
+export declare function isPickingUpItemTrinket(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;

package/types/PickingUpItem.lua

@@ -20,15 +20,15 @@ function ____exports.resetPickingUpItem(self, pickingUpItem)
 end
 local COLLECTIBLE_ITEM_TYPES = __TS__New(Set, {ItemType.PASSIVE, ItemType.ACTIVE, ItemType.FAMILIAR})
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsNull(self, pickingUpItem)
+function ____exports.isPickingUpItemNull(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.NULL
 end
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsCollectible(self, pickingUpItem)
+function ____exports.isPickingUpItemCollectible(self, pickingUpItem)
     return COLLECTIBLE_ITEM_TYPES:has(pickingUpItem.itemType)
 end
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsTrinket(self, pickingUpItem)
+function ____exports.isPickingUpItemTrinket(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.TRINKET
 end
 return ____exports

package/enums/StageTravelEntityState.d.ts

@@ -1,4 +0,0 @@
-export declare enum StageTravelEntityState {
-    OPEN = 0,
-    CLOSED = 1
-}

package/enums/StageTravelEntityState.lua

@@ -1,7 +0,0 @@
-local ____exports = {}
-____exports.StageTravelEntityState = {}
-____exports.StageTravelEntityState.OPEN = 0
-____exports.StageTravelEntityState[____exports.StageTravelEntityState.OPEN] = "OPEN"
-____exports.StageTravelEntityState.CLOSED = 1
-____exports.StageTravelEntityState[____exports.StageTravelEntityState.CLOSED] = "CLOSED"
-return ____exports

package/enums/StageTravelState.d.ts

@@ -1,6 +0,0 @@
-export declare enum StageTravelState {
-    DISABLED = 0,
-    FADING_TO_BLACK = 1,
-    GOING_TO_NEW_FLOOR = 2,
-    FADING_IN = 3
-}

package/enums/StageTravelState.lua

@@ -1,11 +0,0 @@
-local ____exports = {}
-____exports.StageTravelState = {}
-____exports.StageTravelState.DISABLED = 0
-____exports.StageTravelState[____exports.StageTravelState.DISABLED] = "DISABLED"
-____exports.StageTravelState.FADING_TO_BLACK = 1
-____exports.StageTravelState[____exports.StageTravelState.FADING_TO_BLACK] = "FADING_TO_BLACK"
-____exports.StageTravelState.GOING_TO_NEW_FLOOR = 2
-____exports.StageTravelState[____exports.StageTravelState.GOING_TO_NEW_FLOOR] = "GOING_TO_NEW_FLOOR"
-____exports.StageTravelState.FADING_IN = 3
-____exports.StageTravelState[____exports.StageTravelState.FADING_IN] = "FADING_IN"
-return ____exports

package/features/customTrapdoor/constants.d.ts

@@ -1,5 +0,0 @@
-export declare const CUSTOM_TRAPDOOR_FEATURE_NAME = "customTrapdoor";
-/** This also applies to crawl spaces. The value was determined through trial and error. */
-export declare const TRAPDOOR_OPEN_DISTANCE = 60;
-export declare const TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS: number;
-export declare const TRAPDOOR_BOSS_REACTION_FRAMES = 30;

package/features/customTrapdoor/constants.lua

@@ -1,7 +0,0 @@
-local ____exports = {}
-____exports.CUSTOM_TRAPDOOR_FEATURE_NAME = "customTrapdoor"
---- This also applies to crawl spaces. The value was determined through trial and error.
-____exports.TRAPDOOR_OPEN_DISTANCE = 60
-____exports.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____exports.TRAPDOOR_OPEN_DISTANCE * 2.5
-____exports.TRAPDOOR_BOSS_REACTION_FRAMES = 30
-return ____exports

package/features/customTrapdoor/exports.d.ts

@@ -1,37 +0,0 @@
-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:
- *
- * - custom destination (or custom logic for after the player enters)
- * - custom graphics
- * - custom logic for opening/closing
- * - TODO: animation
- *
- * You can use this function to take the player to your custom stage. (See the `registerCustomStage`
- * helper function.)
- *
- * 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 Used to specify where the player will go after jumping into the trapdoor. Can
- *                     either be a tuple containing the stage and stage type, a string containing
- *                     the name of a custom stage, or a function that returns one of these things.
- *                     You can also specify a function that returns undefined in order to perform
- *                     some custom behavior and/or handle the traveling part yourself. By default,
- *                     the destination will be set to the next floor like that of a vanilla
- *                     trapdoor.
- * @param _anm2 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.
- * @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
- *                        every frame to determine if it should open. By default, a function that
- *                        emulates a vanilla trapdoor will be used.
- * @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
- *                         every frame to determine if it should close. By default, a function that
- *                         emulates a vanilla trapdoor will be used.
- * @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
- *                   a boolean or a function returning a boolean. By default, a function that
- *                   emulates a vanilla trapdoor will be used.
- */
-export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, _destination?: [stage: LevelStage, stageType: StageType] | string | ((gridEntity: GridEntity) => [stage: LevelStage, stageType: StageType] | string | undefined), _anm2?: string, _shouldOpenFunc?: (gridEntity: GridEntity) => boolean, _shouldCloseFunc?: (gridEntity: GridEntity) => boolean, _spawnOpen?: boolean | ((gridEntity: GridEntity) => boolean)): GridEntity;

package/features/customTrapdoor/exports.lua

@@ -1,124 +0,0 @@
-local ____exports = {}
-local defaultDestinationFunc, defaultShouldOpenFunc, isPlayerCloseAfterBoss, shouldBeClosedFromStartingInRoomWithEnemies, defaultShouldCloseFunc, defaultShouldSpawnOpenFunc
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
-local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____featuresInitialized = require("featuresInitialized")
-local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
-local ____gridEntity = require("functions.gridEntity")
-local spawnGrid = ____gridEntity.spawnGrid
-local ____nextStage = require("functions.nextStage")
-local getNextStage = ____nextStage.getNextStage
-local getNextStageType = ____nextStage.getNextStageType
-local ____positionVelocity = require("functions.positionVelocity")
-local anyPlayerCloserThan = ____positionVelocity.anyPlayerCloserThan
-local ____roomClearFrame = require("features.roomClearFrame")
-local getRoomClearGameFrame = ____roomClearFrame.getRoomClearGameFrame
-local ____constants = require("features.customTrapdoor.constants")
-local CUSTOM_TRAPDOOR_FEATURE_NAME = ____constants.CUSTOM_TRAPDOOR_FEATURE_NAME
-local TRAPDOOR_BOSS_REACTION_FRAMES = ____constants.TRAPDOOR_BOSS_REACTION_FRAMES
-local TRAPDOOR_OPEN_DISTANCE = ____constants.TRAPDOOR_OPEN_DISTANCE
-local TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____constants.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS
-local ____v = require("features.customTrapdoor.v")
-local getCustomTrapdoorDescription = ____v.getCustomTrapdoorDescription
-function defaultDestinationFunc(self)
-    local nextStage = getNextStage(nil)
-    local nextStageType = getNextStageType(nil)
-    return {nextStage, nextStageType}
-end
-function defaultShouldOpenFunc(self, gridEntity)
-    local entityDescription = getCustomTrapdoorDescription(nil, gridEntity)
-    if entityDescription == nil then
-        return false
-    end
-    local room = game:GetRoom()
-    local roomClear = room:IsClear()
-    return not anyPlayerCloserThan(nil, gridEntity.Position, TRAPDOOR_OPEN_DISTANCE) and not isPlayerCloseAfterBoss(nil, gridEntity.Position) and not shouldBeClosedFromStartingInRoomWithEnemies(nil, entityDescription.initial, roomClear)
-end
-function isPlayerCloseAfterBoss(self, position)
-    local gameFrameCount = game:GetFrameCount()
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomClearGameFrame = getRoomClearGameFrame(nil)
-    if roomType ~= RoomType.BOSS or roomClearGameFrame == nil or gameFrameCount >= roomClearGameFrame + TRAPDOOR_BOSS_REACTION_FRAMES then
-        return false
-    end
-    return anyPlayerCloserThan(nil, position, TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS)
-end
-function shouldBeClosedFromStartingInRoomWithEnemies(self, initial, roomClear)
-    return initial and not roomClear
-end
-function defaultShouldCloseFunc(self)
-    return false
-end
-function defaultShouldSpawnOpenFunc(self, gridEntity)
-    local room = game:GetRoom()
-    local roomFrameCount = room:GetFrameCount()
-    local roomClear = room:IsClear()
-    if roomFrameCount > 0 then
-        return false
-    end
-    if not roomClear then
-        return false
-    end
-    return defaultShouldOpenFunc(nil, gridEntity)
-end
---- Helper function to spawn a trapdoor grid entity that will 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
--- - TODO: animation
--- 
--- You can use this function to take the player to your custom stage. (See the `registerCustomStage`
--- helper function.)
--- 
--- 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 Used to specify where the player will go after jumping into the trapdoor. Can
--- either be a tuple containing the stage and stage type, a string containing
--- the name of a custom stage, or a function that returns one of these things.
--- You can also specify a function that returns undefined in order to perform
--- some custom behavior and/or handle the traveling part yourself. By default,
--- the destination will be set to the next floor like that of a vanilla
--- trapdoor.
--- @param _anm2 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.
--- @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
--- every frame to determine if it should open. By default, a function that
--- emulates a vanilla trapdoor will be used.
--- @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
--- every frame to determine if it should close. By default, a function that
--- emulates a vanilla trapdoor will be used.
--- @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
--- a boolean or a function returning a boolean. By default, a function that
--- emulates a vanilla trapdoor will be used.
-function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, _destination, _anm2, _shouldOpenFunc, _shouldCloseFunc, _spawnOpen)
-    if _destination == nil then
-        _destination = defaultDestinationFunc
-    end
-    if _anm2 == nil then
-        _anm2 = "gfx/grid/door_11_trapdoor.anm2"
-    end
-    if _shouldOpenFunc == nil then
-        _shouldOpenFunc = defaultShouldOpenFunc
-    end
-    if _shouldCloseFunc == nil then
-        _shouldCloseFunc = defaultShouldCloseFunc
-    end
-    if _spawnOpen == nil then
-        _spawnOpen = defaultShouldSpawnOpenFunc
-    end
-    errorIfFeaturesNotInitialized(nil, CUSTOM_TRAPDOOR_FEATURE_NAME)
-    local decoration = spawnGrid(nil, GridEntityType.DECORATION, gridIndexOrPosition)
-    if decoration == nil then
-        error("Failed to spawn a custom trapdoor.")
-    end
-    return decoration
-end
-return ____exports

package/features/customTrapdoor/init.d.ts

@@ -1 +0,0 @@
-export declare function stageTravelInit(): void;

package/features/customTrapdoor/init.lua

@@ -1,11 +0,0 @@
-local ____exports = {}
-local ____exports = require("features.saveDataManager.exports")
-local saveDataManager = ____exports.saveDataManager
-local ____constants = require("features.customTrapdoor.constants")
-local CUSTOM_TRAPDOOR_FEATURE_NAME = ____constants.CUSTOM_TRAPDOOR_FEATURE_NAME
-local ____v = require("features.customTrapdoor.v")
-local v = ____v.default
-function ____exports.stageTravelInit(self)
-    saveDataManager(nil, CUSTOM_TRAPDOOR_FEATURE_NAME, v)
-end
-return ____exports

package/features/customTrapdoor/v.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-import { StageTravelState } from "../../enums/StageTravelState";
-import { StageTravelEntityDescription } from "../../interfaces/StageTravelEntityDescription";
-declare const v: {
-    run: {
-        state: StageTravelState;
-    };
-    room: {
-        /** Indexed by grid index. */
-        trapdoors: Map<number, StageTravelEntityDescription>;
-    };
-};
-export default v;
-export declare function getCustomTrapdoorDescription(gridEntity: GridEntity): StageTravelEntityDescription | undefined;

package/features/customTrapdoor/v.lua

@@ -1,16 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____StageTravelState = require("enums.StageTravelState")
-local StageTravelState = ____StageTravelState.StageTravelState
-local v = {
-    run = {state = StageTravelState.DISABLED},
-    room = {trapdoors = __TS__New(Map)}
-}
-____exports.default = v
-function ____exports.getCustomTrapdoorDescription(self, gridEntity)
-    local gridIndex = gridEntity:GetGridIndex()
-    return v.room.trapdoors:get(gridIndex)
-end
-return ____exports

package/interfaces/StageTravelEntityDescription.d.ts

@@ -1,5 +0,0 @@
-import { StageTravelEntityState } from "../enums/StageTravelEntityState";
-export interface StageTravelEntityDescription {
-    initial: boolean;
-    state: StageTravelEntityState;
-}

package/interfaces/StageTravelEntityDescription.lua

@@ -1,2 +0,0 @@
-local ____exports = {}
-return ____exports