isaacscript-common 4.4.0 → 4.5.2

package/features/saveDataManager/exports.lua

@@ -147,6 +147,7 @@ end
 -- This can make debugging easier, as you can access the variables from the game's debug console.
 -- e.g. `l print(g.feature1.foo)`
 function ____exports.saveDataManagerSetGlobal(self)
+    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
     g = saveDataMap
     gd = saveDataDefaultsMap
 end

package/features/sirenHelpers.lua

@@ -48,12 +48,12 @@ function getSirenHelper(self, familiar)
         function(____, sirenHelper) return sirenHelper.Target ~= nil and GetPtrHash(sirenHelper.Target) == familiarPtrHash end
     )
 end
-local FEATURE_NAME = "siren helpers"
+local FEATURE_NAME = "sirenHelpers"
 v = {run = {familiarBlacklist = {}}}
 ---
 -- @internal
 function ____exports.sirenHelpersInit(self, mod)
-    saveDataManager(nil, "sirenHelpers", v)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallback(ModCallback.POST_NPC_INIT, postNPCInitSirenHelper, EntityType.SIREN_HELPER)
 end
 --- Blacklists a familiar from being stolen by The Siren boss. This should be called once at the

package/features/stageHistory.lua

@@ -17,12 +17,12 @@ function postNewLevelReordered(self)
     local ____v_run_stageHistory_0 = v.run.stageHistory
     ____v_run_stageHistory_0[#____v_run_stageHistory_0 + 1] = {stage, stageType}
 end
-local FEATURE_NAME = "stage history"
+local FEATURE_NAME = "stageHistory"
 v = {run = {stageHistory = {}}}
 ---
 -- @internal
 function ____exports.stageHistoryInit(self, mod)
-    saveDataManager(nil, "stageHistory", v)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_LEVEL_REORDERED, postNewLevelReordered)
 end
 --- Helper function to get all of the stages that a player has visited thus far on this run.

package/features/taintedLazarusPlayers.lua

@@ -43,7 +43,7 @@ function checkDequeue(self)
     v.run.subPlayerMap:set(taintedLazarusPtrHash, deadTaintedLazarusPtr)
     v.run.subPlayerMap:set(deadTaintedLazarusPtrHash, taintedLazarusPtr)
 end
-local FEATURE_NAME = "Tainted Lazarus entity finder"
+local FEATURE_NAME = "taintedLazarusPlayers"
 v = {run = {
     queuedTaintedLazarus = {},
     queuedDeadTaintedLazarus = {},
@@ -54,7 +54,7 @@ v = {run = {
 function ____exports.taintedLazarusPlayersInit(self, mod)
     saveDataManager(
         nil,
-        "taintedLazarusPlayers",
+        FEATURE_NAME,
         v,
         function() return false end
     )

package/featuresInitialized.lua

@@ -9,7 +9,7 @@ end
 -- @internal
 function ____exports.errorIfFeaturesNotInitialized(self, featureName)
     if not ____exports.areFeaturesInitialized(nil) then
-        error(("The " .. featureName) .. " is not initialized. You must first upgrade your mod object by calling the \"upgradeMod\" function.")
+        error(("The \"" .. featureName) .. "\" feature is not initialized. You must first upgrade your mod object by calling the \"upgradeMod\" function.")
     end
 end
 ---

package/functions/rng.lua

@@ -1,6 +1,5 @@
 local ____lualib = require("lualib_bundle")
 local __TS__TypeOf = ____lualib.__TS__TypeOf
-local __TS__ObjectValues = ____lualib.__TS__ObjectValues
 local ____exports = {}
 local RECOMMENDED_SHIFT_IDX, OBJECT_NAME
 local ____cachedClasses = require("cachedClasses")
@@ -123,7 +122,7 @@ 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
-    for ____, value in ipairs(__TS__ObjectValues(table)) do
+    for _key, value in pairs(object) do
         if ____exports.isRNG(nil, value) then
             ____exports.setSeed(nil, value, seed)
         end

package/functions/run.d.ts

@@ -6,7 +6,10 @@ import { PlayerType } from "isaac-typescript-definitions";
  */
 export declare function onSetSeed(): boolean;
 /**
- * Helper function to restart the game using the console command of "restart". You can optionally
- * specify a `PlayerType` to restart the game as that character.
+ * Helper function to restart the run using the console command of "restart". If the player is
+ * playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
+ * will put the player on a run with an entirely new seed.
+ *
+ * You can optionally specify a `PlayerType` to restart the game as that character.
  */
 export declare function restart(character?: PlayerType): void;

package/functions/run.lua

@@ -16,8 +16,11 @@ function ____exports.onSetSeed(self)
     local challenge = Isaac.GetChallenge()
     return challenge == Challenge.NULL and customRun
 end
---- Helper function to restart the game using the console command of "restart". You can optionally
--- specify a `PlayerType` to restart the game as that character.
+--- Helper function to restart the run using the console command of "restart". If the player is
+-- playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
+-- will put the player on a run with an entirely new seed.
+-- 
+-- You can optionally specify a `PlayerType` to restart the game as that character.
 function ____exports.restart(self, character)
     if character == nil then
         log("Restarting.")

package/functions/saveFile.lua

@@ -100,6 +100,9 @@ function ____exports.isCollectibleUnlocked(self, collectibleTypeToCheckFor, item
             end
         end
     end
+    for ____, player in ipairs(taintedLosts) do
+        player:ChangePlayerType(PlayerType.THE_LOST_B)
+    end
     return collectibleUnlocked
 end
 return ____exports

package/functions/stage.d.ts

@@ -36,6 +36,16 @@ export declare function onDarkRoom(): boolean;
 export declare function onFinalFloor(): boolean;
 export declare function onRepentanceStage(): boolean;
 export declare function onSheol(): boolean;
+/**
+ * Helper function to warp to a new stage/level.
+ *
+ * @param stage The stage number to warp to.
+ * @param stageType The stage type to warp to.
+ * @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+ *               this to true if you are warping to the same stage but a different stage type (or
+ *               else the floor layout will be identical to the old floor).
+ */
+export declare function setStage(stage: LevelStage, stageType: StageType, reseed?: boolean): void;
 /**
  * Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
  * console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the

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 ____stageTypeSuffixes = require("objects.stageTypeSuffixes")
+local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
 local ____stageTypeToLetter = require("objects.stageTypeToLetter")
 local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
 function ____exports.isRepentanceStage(self, stageType)
@@ -111,4 +113,22 @@ function ____exports.onSheol(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
 end
+--- Helper function to warp to a new stage/level.
+-- 
+-- @param stage The stage number to warp to.
+-- @param stageType The stage type to warp to.
+-- @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+-- this to true if you are warping to the same stage but a different stage type (or
+-- else the floor layout will be identical to the old floor).
+function ____exports.setStage(self, stage, stageType, reseed)
+    if reseed == nil then
+        reseed = false
+    end
+    local stageTypeSuffix = STAGE_TYPE_SUFFIXES[stageType]
+    local command = ("stage " .. tostring(stage)) .. stageTypeSuffix
+    Isaac.ExecuteCommand(command)
+    if reseed then
+        Isaac.ExecuteCommand("reseed")
+    end
+end
 return ____exports

package/functions/utils.d.ts

@@ -34,6 +34,11 @@ export declare function irange(start: int, end?: int): int[];
  * be a non-zero value in reflections.
  */
 export declare function isReflectionRender(): boolean;
+/**
+ * Helper function to see if a particular command is a vanilla console command. This is useful
+ * because the `EXECUTE_CMD` callback will not fire for any vanilla commands.
+ */
+export declare function isVanillaConsoleCommand(commandName: string): boolean;
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end

package/functions/utils.lua

@@ -6,6 +6,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RenderMode = ____isaac_2Dtypescript_2Ddefinitions.RenderMode
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____consoleCommandsSet = require("sets.consoleCommandsSet")
+local CONSOLE_COMMANDS_SET = ____consoleCommandsSet.CONSOLE_COMMANDS_SET
 local HEX_STRING_LENGTH = 6
 --- Helper function to return an array with the elements from start to end. It is inclusive at the
 -- start and exclusive at the end. (The "e" stands for exclusive.)
@@ -91,6 +93,11 @@ function ____exports.isReflectionRender(self)
     local renderMode = room:GetRenderMode()
     return renderMode == RenderMode.WATER_REFLECT
 end
+--- Helper function to see if a particular command is a vanilla console command. This is useful
+-- because the `EXECUTE_CMD` callback will not fire for any vanilla commands.
+function ____exports.isVanillaConsoleCommand(self, commandName)
+    return CONSOLE_COMMANDS_SET:has(commandName)
+end
 --- Helper function to print something to the in-game console. Use this instead of invoking the
 -- `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
 -- of the message (which `Isaac.ConsoleOutput` does not do by default).

package/index.d.ts

@@ -15,16 +15,17 @@ 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";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
-export { disableAllSound, enableAllSound } from "./features/disableSound";
-export { addConsoleCommand, enableExtraConsoleCommands, removeConsoleCommand, } from "./features/extraConsoleCommands/init";
+export * from "./features/extraConsoleCommands/exports";
 export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
 export { removePersistentEntity, spawnPersistentEntity, } from "./features/persistentEntities";
 export { getPlayerInventory } from "./features/playerInventory";
-export { anyPlayerUsingPony, isPlayerUsingPony as isPonyActive, } from "./features/ponyDetection";
+export { anyPlayerUsingPony, isPlayerUsingPony, } from "./features/ponyDetection";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
+export { registerHotkey, unregisterHotkey } from "./features/registerHotkey";
 export { getRoomClearGameFrame, getRoomClearRoomFrame, } from "./features/roomClearFrame";
 export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, } from "./features/runInNFrames";
 export * from "./features/saveDataManager/exports";

package/index.lua

@@ -125,6 +125,13 @@ do
     ____exports.deployRandomJSONRoom = deployRandomJSONRoom
     ____exports.emptyRoom = emptyRoom
 end
+do
+    local ____disableAllSound = require("features.disableAllSound")
+    local disableAllSound = ____disableAllSound.disableAllSound
+    local enableAllSound = ____disableAllSound.enableAllSound
+    ____exports.disableAllSound = disableAllSound
+    ____exports.enableAllSound = enableAllSound
+end
 do
     local ____disableInputs = require("features.disableInputs")
     local disableAllInputs = ____disableInputs.disableAllInputs
@@ -141,20 +148,12 @@ do
     ____exports.enableAllInputsExceptFor = enableAllInputsExceptFor
 end
 do
-    local ____disableSound = require("features.disableSound")
-    local disableAllSound = ____disableSound.disableAllSound
-    local enableAllSound = ____disableSound.enableAllSound
-    ____exports.disableAllSound = disableAllSound
-    ____exports.enableAllSound = enableAllSound
-end
-do
-    local ____init = require("features.extraConsoleCommands.init")
-    local addConsoleCommand = ____init.addConsoleCommand
-    local enableExtraConsoleCommands = ____init.enableExtraConsoleCommands
-    local removeConsoleCommand = ____init.removeConsoleCommand
-    ____exports.addConsoleCommand = addConsoleCommand
-    ____exports.enableExtraConsoleCommands = enableExtraConsoleCommands
-    ____exports.removeConsoleCommand = removeConsoleCommand
+    local ____export = require("features.extraConsoleCommands.exports")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
 end
 do
     local ____fadeInRemover = require("features.fadeInRemover")
@@ -190,15 +189,22 @@ end
 do
     local ____ponyDetection = require("features.ponyDetection")
     local anyPlayerUsingPony = ____ponyDetection.anyPlayerUsingPony
-    local isPonyActive = ____ponyDetection.isPlayerUsingPony
+    local isPlayerUsingPony = ____ponyDetection.isPlayerUsingPony
     ____exports.anyPlayerUsingPony = anyPlayerUsingPony
-    ____exports.isPonyActive = isPonyActive
+    ____exports.isPlayerUsingPony = isPlayerUsingPony
 end
 do
     local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
     local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
     ____exports.preventCollectibleRotation = preventCollectibleRotation
 end
+do
+    local ____registerHotkey = require("features.registerHotkey")
+    local registerHotkey = ____registerHotkey.registerHotkey
+    local unregisterHotkey = ____registerHotkey.unregisterHotkey
+    ____exports.registerHotkey = registerHotkey
+    ____exports.unregisterHotkey = unregisterHotkey
+end
 do
     local ____roomClearFrame = require("features.roomClearFrame")
     local getRoomClearGameFrame = ____roomClearFrame.getRoomClearGameFrame

package/initFeatures.lua

@@ -9,10 +9,10 @@ local ____init = require("features.customTrapdoor.init")
 local stageTravelInit = ____init.stageTravelInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
+local ____disableAllSound = require("features.disableAllSound")
+local disableAllSoundInit = ____disableAllSound.disableAllSoundInit
 local ____disableInputs = require("features.disableInputs")
 local disableInputsInit = ____disableInputs.disableInputsInit
-local ____disableSound = require("features.disableSound")
-local disableSoundsInit = ____disableSound.disableSoundsInit
 local ____fadeInRemover = require("features.fadeInRemover")
 local fadeInRemoverInit = ____fadeInRemover.fadeInRemoverInit
 local ____fastReset = require("features.fastReset")
@@ -27,6 +27,8 @@ local ____ponyDetection = require("features.ponyDetection")
 local ponyDetectionInit = ____ponyDetection.ponyDetectionInit
 local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
 local preventCollectibleRotationInit = ____preventCollectibleRotation.preventCollectibleRotationInit
+local ____registerHotkey = require("features.registerHotkey")
+local registerHotkeyInit = ____registerHotkey.registerHotkeyInit
 local ____roomClearFrame = require("features.roomClearFrame")
 local roomClearFrameInit = ____roomClearFrame.roomClearFrameInit
 local ____runInNFrames = require("features.runInNFrames")
@@ -44,8 +46,8 @@ function ____exports.initFeaturesMajor(self, mod)
     characterHealthConversionInit(nil, mod)
 end
 function ____exports.initFeaturesMinor(self, mod)
+    disableAllSoundInit(nil, mod)
     disableInputsInit(nil, mod)
-    disableSoundsInit(nil, mod)
     fadeInRemoverInit(nil, mod)
     fastResetInit(nil, mod)
     forgottenSwitchInit(nil, mod)
@@ -54,6 +56,7 @@ function ____exports.initFeaturesMinor(self, mod)
     playerInventoryInit(nil, mod)
     ponyDetectionInit(nil, mod)
     preventCollectibleRotationInit(nil, mod)
+    registerHotkeyInit(nil, mod)
     roomClearFrameInit(nil, mod)
     sirenHelpersInit(nil, mod)
     stageHistoryInit(nil, mod)

package/lualib_bundle.lua

@@ -651,7 +651,7 @@ do
             end
         else
             local ____self_fulfilledCallbacks_2 = self.fulfilledCallbacks
-            ____self_fulfilledCallbacks_2[#____self_fulfilledCallbacks_2 + 1] = function() return resolve(nil, nil) end
+            ____self_fulfilledCallbacks_2[#____self_fulfilledCallbacks_2 + 1] = function(____, v) return resolve(nil, v) end
         end
         if onRejected then
             local internalCallback = self:createPromiseResolvingCallback(onRejected, resolve, reject)
@@ -660,6 +660,9 @@ do
             if isRejected then
                 internalCallback(nil, self.rejectionReason)
             end
+        else
+            local ____self_rejectedCallbacks_4 = self.rejectedCallbacks
+            ____self_rejectedCallbacks_4[#____self_rejectedCallbacks_4 + 1] = function(____, err) return reject(nil, err) end
         end
         if isFulfilled then
             resolve(nil, self.value)
@@ -674,8 +677,8 @@ do
     end
     function __TS__Promise.prototype.finally(self, onFinally)
         if onFinally then
-            local ____self_finallyCallbacks_4 = self.finallyCallbacks
-            ____self_finallyCallbacks_4[#____self_finallyCallbacks_4 + 1] = onFinally
+            local ____self_finallyCallbacks_5 = self.finallyCallbacks
+            ____self_finallyCallbacks_5[#____self_finallyCallbacks_5 + 1] = onFinally
             if self.state ~= 0 then
                 onFinally(nil)
             end

package/objects/stageTypeSuffixes.d.ts

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

package/objects/stageTypeSuffixes.lua

@@ -0,0 +1,12 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+____exports.STAGE_TYPE_SUFFIXES = {
+    [StageType.ORIGINAL] = "",
+    [StageType.WRATH_OF_THE_LAMB] = "a",
+    [StageType.AFTERBIRTH] = "b",
+    [StageType.GREED_MODE] = "",
+    [StageType.REPENTANCE] = "c",
+    [StageType.REPENTANCE_B] = "d"
+}
+return ____exports

package/package.json

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

package/sets/consoleCommandsSet.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The set of vanilla console commands, as documented here:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Debug_Console
+ */
+export declare const CONSOLE_COMMANDS_SET: ReadonlySet<string>;

package/sets/consoleCommandsSet.lua

@@ -0,0 +1,61 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+--- The set of vanilla console commands, as documented here:
+-- https://bindingofisaacrebirth.fandom.com/wiki/Debug_Console
+____exports.CONSOLE_COMMANDS_SET = __TS__New(Set, {
+    "achievement",
+    "challenge",
+    "clear",
+    "clearcache",
+    "clearseeds",
+    "combo",
+    "copy",
+    "costumetest",
+    "curse",
+    "cutscene",
+    "debug",
+    "delirious",
+    "eggs",
+    "giveitem",
+    "g",
+    "goto",
+    "gridspawn",
+    "listcollectibles",
+    "lua",
+    "l",
+    "luamem",
+    "luamod",
+    "luarun",
+    "macro",
+    "m",
+    "metro",
+    "playsfx",
+    "prof",
+    "profstop",
+    "remove",
+    "r",
+    "reloadfx",
+    "reloadshaders",
+    "repeat",
+    "reseed",
+    "restart",
+    "seed",
+    "spawn",
+    "stage",
+    "time",
+    "addplayer",
+    "forceroom",
+    "giveitem2",
+    "g2",
+    "netdelay",
+    "netstart",
+    "remove2",
+    "r2",
+    "reloadwisps",
+    "restock",
+    "rewind",
+    "testbosspool"
+})
+return ____exports