isaacscript-common 4.5.0 → 4.5.1

package/constants.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Constants
+ * @module core/Constants
  */
 import { CollectibleType, ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
 /**

package/features/characterHealthConversion.lua

@@ -65,7 +65,7 @@ function prePickupCollisionHeart(self, pickup, collider)
     end
     return false
 end
-local FEATURE_NAME = "character health manager"
+local FEATURE_NAME = "characterHealthConversion"
 characterHealthReplacementMap = __TS__New(Map)
 ---
 -- @internal
@@ -79,6 +79,9 @@ end
 -- Call this function once at the beginning of your mod to declare the health conversion type.
 function ____exports.registerCharacterHealthConversion(self, playerType, conversionHeartSubType)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if characterHealthReplacementMap:has(playerType) then
+        error(("Failed to register a character of type " .. tostring(playerType)) .. " because there is already an existing registered character with that type.")
+    end
     characterHealthReplacementMap:set(playerType, conversionHeartSubType)
 end
 return ____exports

package/features/characterStats.lua

@@ -25,7 +25,7 @@ function evaluateCache(self, player, cacheFlag)
     local delta = stat - defaultStat
     addStat(nil, player, cacheFlag, delta)
 end
-local FEATURE_NAME = "character stat manager"
+local FEATURE_NAME = "characterStats"
 charactersStatMap = __TS__New(Map)
 ---
 -- @internal

package/features/collectibleItemPoolType.lua

@@ -24,12 +24,12 @@ function postPickupInitCollectible(self, pickup)
     local lastItemPoolType = itemPool:GetLastPool()
     v.run.collectibleItemPoolTypeMap:set(ptrHash, lastItemPoolType)
 end
-local FEATURE_NAME = "get collectible item pool type"
+local FEATURE_NAME = "collectibleItemPoolType"
 v = {run = {collectibleItemPoolTypeMap = __TS__New(Map)}}
 ---
 -- @internal
 function ____exports.collectibleItemPoolTypeInit(self, mod)
-    saveDataManager(nil, "collectibleItemPoolType", v)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallback(ModCallback.POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.COLLECTIBLE)
 end
 --- Helper function to get the item pool type that a given collectible came from. Since there is no

package/features/customTrapdoor/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const STAGE_TRAVEL_FEATURE_NAME = "stageTravel";
+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;

package/features/customTrapdoor/constants.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
-____exports.STAGE_TRAVEL_FEATURE_NAME = "stageTravel"
+____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

package/features/customTrapdoor/exports.lua

@@ -5,6 +5,8 @@ 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")
@@ -15,6 +17,7 @@ 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
@@ -111,6 +114,7 @@ function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, _destination
     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.")

package/features/customTrapdoor/init.lua

@@ -2,10 +2,10 @@ local ____exports = {}
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____constants = require("features.customTrapdoor.constants")
-local STAGE_TRAVEL_FEATURE_NAME = ____constants.STAGE_TRAVEL_FEATURE_NAME
+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, STAGE_TRAVEL_FEATURE_NAME, v)
+    saveDataManager(nil, CUSTOM_TRAPDOOR_FEATURE_NAME, v)
 end
 return ____exports

package/features/debugDisplay/debugDisplay.d.ts

@@ -1,2 +1,6 @@
 import { ModUpgraded } from "../../classes/ModUpgraded";
+/**
+ * The debug display feature is only initialized when the extra console commands feature is
+ * initialized.
+ */
 export declare function debugDisplayInit(mod: ModUpgraded): void;

package/features/debugDisplay/debugDisplay.lua

@@ -152,6 +152,8 @@ function postPressurePlateRender(self, pressurePlate)
     local text = debugDisplayTextCallbacks:pressurePlate(pressurePlate)
     renderTextOnEntity(nil, pressurePlate, text)
 end
+--- The debug display feature is only initialized when the extra console commands feature is
+-- initialized.
 function ____exports.debugDisplayInit(self, mod)
     saveDataManager(
         nil,

package/features/deployJSONRoom.lua

@@ -451,7 +451,7 @@ function getPitFrame(self, L, R, U, D, UL, UR, DL, DR)
     end
     return F
 end
-FEATURE_NAME = "JSON room deployer"
+FEATURE_NAME = "deployJSONRoom"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
 v = {
@@ -471,7 +471,7 @@ v = {
 ---
 -- @internal
 function ____exports.deployJSONRoomInit(self, mod)
-    saveDataManager(nil, "deployJSONRoom", v)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallback(ModCallback.PRE_USE_ITEM, preUseItemWeNeedToGoDeeper, CollectibleType.WE_NEED_TO_GO_DEEPER)
     mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end

package/features/{disableSound.d.ts → disableAllSound.d.ts}

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

package/features/{disableSound.lua → disableAllSound.lua}

@@ -19,13 +19,13 @@ function postRender(self)
     end
     stopAllSoundEffects(nil)
 end
-local FEATURE_NAME = "sound disabler"
+local FEATURE_NAME = "disableAllSound"
 local musicWasEnabled = false
 v = {run = {disableSoundSet = __TS__New(Set)}}
 ---
 -- @internal
-function ____exports.disableSoundsInit(self, mod)
-    saveDataManager(nil, "disableSounds", v)
+function ____exports.disableAllSoundInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
 --- Helper function to stop muting all sound effects and music.

package/features/disableInputs.lua

@@ -44,7 +44,7 @@ function getReturnValue(self, buttonAction, booleanCallback)
     end
     return nil
 end
-local FEATURE_NAME = "input disabler"
+local FEATURE_NAME = "disableInputs"
 v = {run = {
     disableInputsWithWhitelistMap = __TS__New(Map),
     enableInputsWithBlacklistMap = __TS__New(Map)
@@ -52,7 +52,7 @@ v = {run = {
 ---
 -- @internal
 function ____exports.disableInputsInit(self, mod)
-    saveDataManager(nil, "disableInputs", v)
+    saveDataManager(nil, FEATURE_NAME, v)
     mod:AddCallback(ModCallback.INPUT_ACTION, isActionPressed, InputHook.IS_ACTION_PRESSED)
     mod:AddCallback(ModCallback.INPUT_ACTION, isActionTriggered, InputHook.IS_ACTION_TRIGGERED)
     mod:AddCallback(ModCallback.INPUT_ACTION, getActionValue, InputHook.GET_ACTION_VALUE)

package/features/extraConsoleCommands/exports.d.ts

@@ -0,0 +1,26 @@
+import { ModUpgraded } from "../../classes/ModUpgraded";
+/**
+ * Enables extra console commands which are useful for debugging. See [the
+ * docs](https://isaacscript.github.io/isaacscript-common/features/extraConsoleCommands_listCommands)
+ * for the specific commands that are added.
+ */
+export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
+/**
+ * Helper function to add a custom console command.
+ *
+ * The standard library comes with many existing console commands that are useful for debugging, but
+ * you can also add your own commands that are useful for your particular mod. It's easier to add
+ * commands to the existing command system than to add logic manually to the ExecuteCmd callback.
+ *
+ * Before using this function, you must first invoke `enableExtraConsoleCommands`.
+ */
+export declare function addConsoleCommand(commandName: string, commandFunction: (params: string) => void): void;
+/**
+ * Helper function to remove a custom console command.
+ *
+ * The standard library comes with many existing console commands that are useful for debugging. If
+ * you want to disable one of them, use this function.
+ *
+ * Before using this function, you must first invoke `enableExtraConsoleCommands`.
+ */
+export declare function removeConsoleCommand(commandName: string): void;

package/features/extraConsoleCommands/exports.lua

@@ -0,0 +1,54 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local ____exports = {}
+local ____utils = require("functions.utils")
+local isVanillaConsoleCommand = ____utils.isVanillaConsoleCommand
+local ____init = require("features.extraConsoleCommands.init")
+local extraConsoleCommandsInit = ____init.extraConsoleCommandsInit
+local ____v = require("features.extraConsoleCommands.v")
+local extraConsoleCommandsFunctionMap = ____v.extraConsoleCommandsFunctionMap
+local isExtraConsoleCommandsInitialized = ____v.isExtraConsoleCommandsInitialized
+--- Enables extra console commands which are useful for debugging. See [the
+-- docs](https://isaacscript.github.io/isaacscript-common/features/extraConsoleCommands_listCommands)
+-- for the specific commands that are added.
+function ____exports.enableExtraConsoleCommands(self, mod)
+    if isExtraConsoleCommandsInitialized(nil) then
+        error("The extra console commands are already initialized.")
+    end
+    extraConsoleCommandsInit(nil, mod)
+end
+--- Helper function to add a custom console command.
+-- 
+-- The standard library comes with many existing console commands that are useful for debugging, but
+-- you can also add your own commands that are useful for your particular mod. It's easier to add
+-- commands to the existing command system than to add logic manually to the ExecuteCmd callback.
+-- 
+-- Before using this function, you must first invoke `enableExtraConsoleCommands`.
+function ____exports.addConsoleCommand(self, commandName, commandFunction)
+    if not isExtraConsoleCommandsInitialized(nil) then
+        error("The \"extraConsoleCommands\" feature is not initialized. Before adding extra console commands, you must first enable the feature by invoking the \"enableExtraConsoleCommands\" function.")
+    end
+    if isVanillaConsoleCommand(nil, commandName) then
+        error(("Failed to add a new console command of \"" .. commandName) .. "\" because that name already belongs to a vanilla command. You must pick a non-colliding name.")
+    end
+    if extraConsoleCommandsFunctionMap:has(commandName) then
+        error(("Failed to add a new console command of \"" .. commandName) .. "\" because there is already an existing custom command by that name. If you want to overwrite a command from the standard library, you can use the \"removeExtraConsoleCommand\" function.")
+    end
+    extraConsoleCommandsFunctionMap:set(commandName, commandFunction)
+end
+--- Helper function to remove a custom console command.
+-- 
+-- The standard library comes with many existing console commands that are useful for debugging. If
+-- you want to disable one of them, use this function.
+-- 
+-- Before using this function, you must first invoke `enableExtraConsoleCommands`.
+function ____exports.removeConsoleCommand(self, commandName)
+    if not isExtraConsoleCommandsInitialized(nil) then
+        error("The \"extraConsoleCommands\" feature is not initialized. Before removing console commands, you must first enable the feature by invoking the \"enableExtraConsoleCommands\" function.")
+    end
+    if not extraConsoleCommandsFunctionMap:has(commandName) then
+        error(("Failed to remove the console command of \"" .. commandName) .. "\", since it does not already exist in the map.")
+    end
+    extraConsoleCommandsFunctionMap:delete(commandName)
+end
+return ____exports

package/features/extraConsoleCommands/init.d.ts

@@ -1,26 +1,2 @@
 import { ModUpgraded } from "../../classes/ModUpgraded";
-/**
- * Enables extra console commands which are useful for debugging. See [the
- * docs](https://isaacscript.github.io/isaacscript-common/features/extraConsoleCommands_listCommands)
- * for the specific commands that are added.
- */
-export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
-/**
- * Helper function to add a custom console command.
- *
- * The standard library comes with many existing console commands that are useful for debugging, but
- * you can also add your own commands that are useful for your particular mod. It's easier to add
- * commands to the existing command system than to add logic manually to the ExecuteCmd callback.
- *
- * Before using this function, you must first invoke `enableExtraConsoleCommands`.
- */
-export declare function addConsoleCommand(commandName: string, commandFunction: (params: string) => void): void;
-/**
- * Helper function to remove a custom console command.
- *
- * The standard library comes with many existing console commands that are useful for debugging. If
- * you want to disable one of them, use this function.
- *
- * Before using this function, you must first invoke `enableExtraConsoleCommands`.
- */
-export declare function removeConsoleCommand(commandName: string): void;
+export declare function extraConsoleCommandsInit(mod: ModUpgraded): void;