isaacscript-common 4.2.4 → 4.2.8

package/enums/StageTravelEntityType.d.ts

@@ -0,0 +1,5 @@
+export declare enum StageTravelEntityType {
+    TRAPDOOR = 0,
+    CRAWLSPACE = 1,
+    HEAVEN_DOOR = 2
+}

package/enums/StageTravelEntityType.lua

@@ -0,0 +1,9 @@
+local ____exports = {}
+____exports.StageTravelEntityType = {}
+____exports.StageTravelEntityType.TRAPDOOR = 0
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.TRAPDOOR] = "TRAPDOOR"
+____exports.StageTravelEntityType.CRAWLSPACE = 1
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.CRAWLSPACE] = "CRAWLSPACE"
+____exports.StageTravelEntityType.HEAVEN_DOOR = 2
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.HEAVEN_DOOR] = "HEAVEN_DOOR"
+return ____exports

package/enums/private/SaveDataKey.d.ts

@@ -4,4 +4,3 @@ export declare enum SaveDataKey {
     LEVEL = "level",
     ROOM = "room"
 }
-export declare const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey>;

package/enums/private/SaveDataKey.lua

@@ -1,11 +1,7 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 ____exports.SaveDataKey = {}
 ____exports.SaveDataKey.PERSISTENT = "persistent"
 ____exports.SaveDataKey.RUN = "run"
 ____exports.SaveDataKey.LEVEL = "level"
 ____exports.SaveDataKey.ROOM = "room"
-____exports.RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {____exports.SaveDataKey.RUN, ____exports.SaveDataKey.LEVEL, ____exports.SaveDataKey.ROOM})
 return ____exports

package/features/saveDataManager/main.lua

@@ -1,7 +1,9 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, mod, loadedDataOnThisRun
+local postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, RESETTABLE_SAVE_DATA_KEYS, mod, loadedDataOnThisRun
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____cachedClasses = require("cachedClasses")
@@ -9,7 +11,6 @@ local game = ____cachedClasses.game
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____SaveDataKey = require("enums.private.SaveDataKey")
-local RESETTABLE_SAVE_DATA_KEYS = ____SaveDataKey.RESETTABLE_SAVE_DATA_KEYS
 local SaveDataKey = ____SaveDataKey.SaveDataKey
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
@@ -102,6 +103,7 @@ function clearAndCopyAllElements(self, oldTable, newTable)
         oldTable[key] = value
     end
 end
+RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {SaveDataKey.RUN, SaveDataKey.LEVEL, SaveDataKey.ROOM})
 mod = nil
 loadedDataOnThisRun = false
 ---

package/features/stageTravel/exports.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
+ *
+ * - custom sprite
+ * - custom opening/closing logic
+ * - custom destination / logic for after the player enters
+ */
+export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector): GridEntity;
+/**
+ * Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
+ * custom attributes:
+ *
+ * - custom sprite
+ * - custom opening/closing logic
+ * - custom destination / logic for after the player enters
+ */
+export declare function initCustomTrapdoor(_trapdoor: GridEntity, _shouldSpawnOpenFunc?: typeof defaultShouldSpawnOpenFunc): void;
+declare function defaultShouldSpawnOpenFunc(_entity: GridEntity | EntityEffect): boolean;
+export {};

package/features/stageTravel/exports.lua

@@ -0,0 +1,44 @@
+local ____exports = {}
+local defaultShouldSpawnOpenFunc
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____gridEntity = require("functions.gridEntity")
+local spawnGrid = ____gridEntity.spawnGrid
+--- Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
+-- custom attributes:
+-- 
+-- - custom sprite
+-- - custom opening/closing logic
+-- - custom destination / logic for after the player enters
+function ____exports.initCustomTrapdoor(self, _trapdoor, _shouldSpawnOpenFunc)
+    if _shouldSpawnOpenFunc == nil then
+        _shouldSpawnOpenFunc = defaultShouldSpawnOpenFunc
+    end
+end
+function defaultShouldSpawnOpenFunc(self, _entity)
+    local room = game:GetRoom()
+    local roomFrameCount = room:GetFrameCount()
+    local roomClear = room:IsClear()
+    if roomFrameCount == 0 then
+        if not roomClear then
+            return false
+        end
+    end
+    return false
+end
+--- Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
+-- 
+-- - custom sprite
+-- - custom opening/closing logic
+-- - custom destination / logic for after the player enters
+function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition)
+    local trapdoor = spawnGrid(nil, GridEntityType.TRAPDOOR, gridIndexOrPosition)
+    if trapdoor == nil then
+        error("Failed to spawn a custom trapdoor.")
+    end
+    ____exports.initCustomTrapdoor(nil, trapdoor)
+    return trapdoor
+end
+return ____exports

package/functions/character.d.ts

@@ -42,7 +42,7 @@ export declare function getCharacterDeathAnimationName(character: PlayerType): s
  * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
  */
 export declare function getCharacterMaxHeartContainers(character: PlayerType): int;
-/** Helper function to get the name of a character. Returns "unknown" for modded characters. */
+/** Helper function to get the name of a character. Returns "Unknown" for modded characters. */
 export declare function getCharacterName(character: PlayerType): string;
 export declare function isModdedCharacter(character: PlayerType): boolean;
 export declare function isVanillaCharacter(character: PlayerType): boolean;

package/functions/character.lua

@@ -5,7 +5,6 @@ local ____constantsFirstLast = require("constantsFirstLast")
 local LAST_VANILLA_CHARACTER = ____constantsFirstLast.LAST_VANILLA_CHARACTER
 local ____characterNames = require("objects.characterNames")
 local CHARACTER_NAMES = ____characterNames.CHARACTER_NAMES
-local DEFAULT_CHARACTER_NAME = ____characterNames.DEFAULT_CHARACTER_NAME
 local ____charactersThatStartWithAnActiveItemSet = require("sets.charactersThatStartWithAnActiveItemSet")
 local CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET = ____charactersThatStartWithAnActiveItemSet.CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET
 local ____charactersWithBlackHeartFromEternalHeartSet = require("sets.charactersWithBlackHeartFromEternalHeartSet")
@@ -18,6 +17,9 @@ local ____charactersWithNoSoulHeartsSet = require("sets.charactersWithNoSoulHear
 local CHARACTERS_WITH_NO_SOUL_HEARTS_SET = ____charactersWithNoSoulHeartsSet.CHARACTERS_WITH_NO_SOUL_HEARTS_SET
 local ____lostStyleCharactersSet = require("sets.lostStyleCharactersSet")
 local LOST_STYLE_CHARACTERS_SET = ____lostStyleCharactersSet.LOST_STYLE_CHARACTERS_SET
+function ____exports.isModdedCharacter(self, character)
+    return not ____exports.isVanillaCharacter(nil, character)
+end
 function ____exports.isVanillaCharacter(self, character)
     return character <= LAST_VANILLA_CHARACTER
 end
@@ -82,15 +84,11 @@ function ____exports.getCharacterMaxHeartContainers(self, character)
     end
     return 12
 end
---- Helper function to get the name of a character. Returns "unknown" for modded characters.
+--- Helper function to get the name of a character. Returns "Unknown" for modded characters.
 function ____exports.getCharacterName(self, character)
-    if ____exports.isVanillaCharacter(nil, character) then
-        return "unknown"
+    if ____exports.isModdedCharacter(nil, character) then
+        return "Unknown"
     end
-    local characterName = CHARACTER_NAMES[character]
-    return characterName == nil and DEFAULT_CHARACTER_NAME or characterName
-end
-function ____exports.isModdedCharacter(self, character)
-    return not ____exports.isVanillaCharacter(nil, character)
+    return CHARACTER_NAMES[character]
 end
 return ____exports

package/functions/collectibleCacheFlag.lua

@@ -7,8 +7,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleArray = ____collectibleSet.getCollectibleArray
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
@@ -29,7 +29,7 @@ local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local collectiblesSet = __TS__New(Set)
-        for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
+        for ____, collectibleType in ipairs(getCollectibleArray(nil)) do
             if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
                 collectiblesSet:add(collectibleType)
             end

package/functions/collectibleSet.lua

@@ -6,9 +6,11 @@ local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
+local LAST_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_COLLECTIBLE_TYPE
 local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local ALL_COLLECTIBLES_ARRAY = {}
 local VANILLA_COLLECTIBLES_ARRAY = {}
 local MODDED_COLLECTIBLES_ARRAY = {}
@@ -19,7 +21,8 @@ local function initCollectibleArraysAndSets(self)
     if #ALL_COLLECTIBLES_ARRAY ~= 0 then
         return
     end
-    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
+    local collectibleTypeRange = irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE)
+    for ____, collectibleType in ipairs(collectibleTypeRange) do
         do
             local itemConfigItem = itemConfig:GetCollectible(collectibleType)
             if itemConfigItem == nil then

package/functions/collectibleTag.lua

@@ -8,8 +8,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleArray = ____collectibleSet.getCollectibleArray
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
@@ -33,7 +33,7 @@ local function initTagMap(self)
             __TS__New(Set)
         )
     end
-    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
+    for ____, collectibleType in ipairs(getCollectibleArray(nil)) do
         for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
             do
                 if not ____exports.collectibleHasTag(nil, collectibleType, itemConfigTag) then

package/functions/collectibles.d.ts

@@ -106,15 +106,6 @@ export declare function getCollectibleQuality(collectibleType: CollectibleType):
  * ```
  */
 export declare function getCollectibleTags(collectibleType: CollectibleType): BitFlags<ItemConfigTag>;
-/**
- * Helper function to get an array that represents the range from the first collectible type to the
- * last collectible type. This will include integers that do not represent any valid collectible
- * types.
- *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getCollectibleSet` helper function instead.
- */
-export declare function getCollectibleTypeRange(): CollectibleType[];
 /**
  * Helper function to get an array that represents the all modded collectible types.
  *

package/functions/collectibles.lua

@@ -311,15 +311,6 @@ function ____exports.getCollectibleTags(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     return itemConfigItem == nil and ItemConfigTagZero or itemConfigItem.Tags
 end
---- Helper function to get an array that represents the range from the first collectible type to the
--- last collectible type. This will include integers that do not represent any valid collectible
--- types.
--- 
--- This function is only useful when building collectible type objects. For most purposes, you
--- should use the `getCollectibleSet` helper function instead.
-function ____exports.getCollectibleTypeRange(self)
-    return irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE)
-end
 --- Helper function to get an array that represents the all modded collectible types.
 -- 
 -- This function is only useful when building collectible type objects. For most purposes, you

package/functions/playerHealth.lua

@@ -20,10 +20,7 @@ local getPlayerBlackHearts = ____player.getPlayerBlackHearts
 local getPlayerHearts = ____player.getPlayerHearts
 local getPlayerSoulHearts = ____player.getPlayerSoulHearts
 local isCharacter = ____player.isCharacter
-local isKeeper = ____player.isKeeper
 local setActiveItem = ____player.setActiveItem
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
 function ____exports.removeAllPlayerHealth(self, player)
     local goldenHearts = player:GetGoldenHearts()
     local eternalHearts = player:GetEternalHearts()
@@ -89,24 +86,15 @@ function ____exports.setPlayerHealth(self, player, playerHealth)
             end
         end
     )
-    if isKeeper(nil, player) then
-        local numCoinsToHeal = playerHealth.hearts / 2
-        player:AddCoins(numCoinsToHeal)
+    player:AddRottenHearts(playerHealth.rottenHearts)
+    if character == PlayerType.MAGDALENE_B then
+        local effectiveHearts = playerHealth.hearts / 2
+        player:AddHearts(effectiveHearts)
     else
-        player:AddRottenHearts(playerHealth.rottenHearts)
-        ____repeat(
-            nil,
-            playerHealth.hearts,
-            function()
-                player:AddHearts(1)
-                if character == PlayerType.MAGDALENE_B then
-                    player:AddHearts(-1)
-                end
-            end
-        )
-        player:AddGoldenHearts(playerHealth.goldenHearts)
-        player:AddBrokenHearts(playerHealth.brokenHearts)
+        player:AddHearts(playerHealth.hearts)
     end
+    player:AddGoldenHearts(playerHealth.goldenHearts)
+    player:AddBrokenHearts(playerHealth.brokenHearts)
     if character == PlayerType.BETHANY then
         player:SetSoulCharge(playerHealth.soulCharges)
     elseif character == PlayerType.BETHANY_B then

package/objects/characterNames.d.ts

@@ -1,5 +1,4 @@
 import { PlayerType } from "isaac-typescript-definitions";
-export declare const DEFAULT_CHARACTER_NAME = "Unknown";
 export declare const CHARACTER_NAMES: {
     readonly [key in PlayerType]: string;
 };

package/objects/characterNames.lua

@@ -1,7 +1,6 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
-____exports.DEFAULT_CHARACTER_NAME = "Unknown"
 ____exports.CHARACTER_NAMES = {
     [PlayerType.POSSESSOR] = "Possessor",
     [PlayerType.ISAAC] = "Isaac",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.2.4",
+  "version": "4.2.8",
   "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.11"
+    "isaac-typescript-definitions": "^3.0.12"
   }
 }