isaacscript-common 2.0.32 → 2.1.0

package/features/debugDisplay/exports.lua

@@ -0,0 +1,133 @@
+local ____exports = {}
+local ____utils = require("functions.utils")
+local printEnabled = ____utils.printEnabled
+local ____v = require("features.debugDisplay.v")
+local v = ____v.default
+local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+function ____exports.setPlayerDisplay(self, textCallback)
+    debugDisplayTextCallbacks.player = textCallback
+end
+function ____exports.setTearDisplay(self, textCallback)
+    debugDisplayTextCallbacks.tear = textCallback
+end
+function ____exports.setFamiliarDisplay(self, textCallback)
+    debugDisplayTextCallbacks.familiar = textCallback
+end
+function ____exports.setBombDisplay(self, textCallback)
+    debugDisplayTextCallbacks.bomb = textCallback
+end
+function ____exports.setPickupDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pickup = textCallback
+end
+function ____exports.setSlotDisplay(self, textCallback)
+    debugDisplayTextCallbacks.slot = textCallback
+end
+function ____exports.setLaserDisplay(self, textCallback)
+    debugDisplayTextCallbacks.laser = textCallback
+end
+function ____exports.setKnifeDisplay(self, textCallback)
+    debugDisplayTextCallbacks.knife = textCallback
+end
+function ____exports.setProjectileDisplay(self, textCallback)
+    debugDisplayTextCallbacks.projectile = textCallback
+end
+function ____exports.setEffectDisplay(self, textCallback)
+    debugDisplayTextCallbacks.effect = textCallback
+end
+function ____exports.setNPCDisplay(self, textCallback)
+    debugDisplayTextCallbacks.npc = textCallback
+end
+function ____exports.setRockDisplay(self, textCallback)
+    debugDisplayTextCallbacks.rock = textCallback
+end
+function ____exports.setPitDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pit = textCallback
+end
+function ____exports.setSpikesDisplay(self, textCallback)
+    debugDisplayTextCallbacks.spikes = textCallback
+end
+function ____exports.setTNTDisplay(self, textCallback)
+    debugDisplayTextCallbacks.tnt = textCallback
+end
+function ____exports.setPoopDisplay(self, textCallback)
+    debugDisplayTextCallbacks.poop = textCallback
+end
+function ____exports.setDoorDisplay(self, textCallback)
+    debugDisplayTextCallbacks.door = textCallback
+end
+function ____exports.setPressurePlateDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pressurePlate = textCallback
+end
+function ____exports.togglePlayerDisplay(self)
+    v.run.player = not v.run.player
+    printEnabled(nil, v.run.player, "player display")
+end
+function ____exports.toggleTearDisplay(self)
+    v.run.tear = not v.run.tear
+    printEnabled(nil, v.run.tear, "tear display")
+end
+function ____exports.toggleFamiliarDisplay(self)
+    v.run.familiar = not v.run.familiar
+    printEnabled(nil, v.run.familiar, "familiar display")
+end
+function ____exports.toggleBombDisplay(self)
+    v.run.bomb = not v.run.bomb
+    printEnabled(nil, v.run.bomb, "bomb display")
+end
+function ____exports.togglePickupDisplay(self)
+    v.run.pickup = not v.run.pickup
+    printEnabled(nil, v.run.pickup, "pickup display")
+end
+function ____exports.toggleSlotDisplay(self)
+    v.run.slot = not v.run.slot
+    printEnabled(nil, v.run.slot, "slot display")
+end
+function ____exports.toggleLaserDisplay(self)
+    v.run.laser = not v.run.laser
+    printEnabled(nil, v.run.laser, "laser display")
+end
+function ____exports.toggleKnifeDisplay(self)
+    v.run.knife = not v.run.knife
+    printEnabled(nil, v.run.knife, "knife display")
+end
+function ____exports.toggleProjectileDisplay(self)
+    v.run.projectile = not v.run.projectile
+    printEnabled(nil, v.run.projectile, "projectile display")
+end
+function ____exports.toggleEffectDisplay(self)
+    v.run.effect = not v.run.effect
+    printEnabled(nil, v.run.effect, "effect display")
+end
+function ____exports.toggleNPCDisplay(self)
+    v.run.npc = not v.run.npc
+    printEnabled(nil, v.run.npc, "NPC display")
+end
+function ____exports.toggleRockDisplay(self)
+    v.run.rock = not v.run.rock
+    printEnabled(nil, v.run.rock, "rock display")
+end
+function ____exports.togglePitDisplay(self)
+    v.run.pit = not v.run.pit
+    printEnabled(nil, v.run.pit, "pit display")
+end
+function ____exports.toggleSpikesDisplay(self)
+    v.run.spikes = not v.run.spikes
+    printEnabled(nil, v.run.spikes, "spikes display")
+end
+function ____exports.toggleTNTDisplay(self)
+    v.run.tnt = not v.run.tnt
+    printEnabled(nil, v.run.tnt, "TNT display")
+end
+function ____exports.togglePoopDisplay(self)
+    v.run.poop = not v.run.poop
+    printEnabled(nil, v.run.poop, "poop display")
+end
+function ____exports.toggleDoorDisplay(self)
+    v.run.door = not v.run.door
+    printEnabled(nil, v.run.door, "door display")
+end
+function ____exports.togglePressurePlateDisplay(self)
+    v.run.pressurePlate = not v.run.pressurePlate
+    printEnabled(nil, v.run.pressurePlate, "pressure plate display")
+end
+return ____exports

package/features/debugDisplay/v.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="isaac-typescript-definitions" />
+declare const v: {
+    run: {
+        player: boolean;
+        tear: boolean;
+        familiar: boolean;
+        bomb: boolean;
+        pickup: boolean;
+        slot: boolean;
+        laser: boolean;
+        knife: boolean;
+        projectile: boolean;
+        effect: boolean;
+        npc: boolean;
+        rock: boolean;
+        pit: boolean;
+        spikes: boolean;
+        tnt: boolean;
+        poop: boolean;
+        door: boolean;
+        pressurePlate: boolean;
+    };
+};
+export default v;
+export declare const debugDisplayTextCallbacks: {
+    player: (player: EntityPlayer) => string;
+    tear: (tear: EntityTear) => string;
+    familiar: (familiar: EntityFamiliar) => string;
+    bomb: (bomb: EntityBomb) => string;
+    pickup: (pickup: EntityPickup) => string;
+    slot: (familiar: Entity) => string;
+    laser: (laser: EntityLaser) => string;
+    knife: (knife: EntityKnife) => string;
+    projectile: (projectile: EntityProjectile) => string;
+    effect: (effect: EntityEffect) => string;
+    npc: (effect: EntityNPC) => string;
+    rock: (rock: GridEntityRock) => string;
+    pit: (pit: GridEntityPit) => string;
+    spikes: (spikes: GridEntitySpikes) => string;
+    tnt: (tnt: GridEntityTNT) => string;
+    poop: (poop: GridEntityPoop) => string;
+    door: (door: GridEntityDoor) => string;
+    pressurePlate: (pressurePlate: GridEntityPressurePlate) => string;
+};

package/features/debugDisplay/v.lua

@@ -0,0 +1,54 @@
+local ____exports = {}
+local defaultEntityDisplayCallback, defaultGridEntityDisplayCallback
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____gridEntity = require("functions.gridEntity")
+local getGridEntityID = ____gridEntity.getGridEntityID
+function defaultEntityDisplayCallback(self, entity)
+    return getEntityID(nil, entity)
+end
+function defaultGridEntityDisplayCallback(self, gridEntity)
+    return getGridEntityID(nil, gridEntity)
+end
+local v = {run = {
+    player = false,
+    tear = false,
+    familiar = false,
+    bomb = false,
+    pickup = false,
+    slot = false,
+    laser = false,
+    knife = false,
+    projectile = false,
+    effect = false,
+    npc = false,
+    rock = false,
+    pit = false,
+    spikes = false,
+    tnt = false,
+    poop = false,
+    door = false,
+    pressurePlate = false
+}}
+____exports.default = v
+____exports.debugDisplayTextCallbacks = {
+    player = defaultEntityDisplayCallback,
+    tear = defaultEntityDisplayCallback,
+    familiar = defaultEntityDisplayCallback,
+    bomb = defaultEntityDisplayCallback,
+    pickup = defaultEntityDisplayCallback,
+    slot = defaultEntityDisplayCallback,
+    laser = defaultEntityDisplayCallback,
+    knife = defaultEntityDisplayCallback,
+    projectile = defaultEntityDisplayCallback,
+    effect = defaultEntityDisplayCallback,
+    npc = defaultEntityDisplayCallback,
+    rock = defaultGridEntityDisplayCallback,
+    pit = defaultGridEntityDisplayCallback,
+    spikes = defaultGridEntityDisplayCallback,
+    tnt = defaultGridEntityDisplayCallback,
+    poop = defaultGridEntityDisplayCallback,
+    door = defaultGridEntityDisplayCallback,
+    pressurePlate = defaultGridEntityDisplayCallback
+}
+return ____exports

package/{dist/features → features}/disableInputs.d.ts

@@ -11,7 +11,7 @@ export declare function enableAllInputs(key: string): void;
  * Helper function to disable all inputs. This is useful because `EntityPlayer.ControlsEnabled` can
  * be changed by the game under certain conditions.
  *
- * Use the [[`enableAllInputs`]] helper function to set things back to normal.
+ * Use the `enableAllInputs` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.
@@ -21,7 +21,7 @@ export declare function disableAllInputs(key: string): void;
  * Helper function to enable all inputs besides the ones provided. This is useful because
  * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
  *
- * Use the [[`enableAllInputs`]] helper function to set things back to normal.
+ * Use the `enableAllInputs` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.
@@ -32,7 +32,7 @@ export declare function enableAllInputsExceptFor(key: string, blacklist: Set<But
  * Helper function to disable all inputs besides the ones provided. This is useful because
  * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
  *
- * Use the [[`enableAllInputs`]] helper function to set things back to normal.
+ * Use the `enableAllInputs` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.
@@ -44,7 +44,7 @@ export declare function disableAllInputsExceptFor(key: string, whitelist: Set<Bu
  * the UI). This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under
  * certain conditions.
  *
- * Use the [[`enableAllInputs`]] helper function to set things back to normal.
+ * Use the `enableAllInputs` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.
@@ -54,7 +54,7 @@ export declare function disableMovementInputs(key: string): void;
  * Helper function to disable only the inputs used for shooting tears. This is useful because
  * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
  *
- * Use the [[`enableAllInputs`]] helper function to set things back to normal.
+ * Use the `enableAllInputs` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.

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

@@ -1,7 +1,7 @@
 /**
  * Helper function to stop muting all sound effects and music.
  *
- * Use this function to set things back to normal after having used [[`disableAllSounds`]].
+ * Use this function to set things back to normal after having used `disableAllSounds`.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.
@@ -10,7 +10,7 @@ export declare function enableAllSound(key: string): void;
 /**
  * Helper function to disable all sound effects and music (by constantly musting them).
  *
- * Use the [[`enableAllSounds`]] helper function to set things back to normal.
+ * Use the `enableAllSounds` helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
  *            that multiple mod features can work in tandem.

package/{dist/features → features}/extraConsoleCommands/commands.d.ts

@@ -152,6 +152,8 @@ export declare function goldenKey(): void;
 export declare function grid(): void;
 /** Alias for the "debug 11" command. */
 export declare function grid2(): void;
+/** Spawns every grid entity, starting at the top-left-most tile. */
+export declare function gridEntities(): void;
 /** Alias for the "hearts" command. */
 export declare function h(params: string): void;
 /**

package/{dist/features → features}/extraConsoleCommands/commands.lua

@@ -12,6 +12,7 @@ local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
 local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
 local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
 local PillColor = ____isaac_2Dtypescript_2Ddefinitions.PillColor
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
@@ -45,6 +46,8 @@ local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
 local addFlag = ____flag.addFlag
+local ____gridEntity = require("functions.gridEntity")
+local spawnGrid = ____gridEntity.spawnGrid
 local ____log = require("functions.log")
 local logEffects = ____log.logEffects
 local logRoom = ____log.logRoom
@@ -467,6 +470,29 @@ end
 function ____exports.grid2(self)
     Isaac.ExecuteCommand("debug 11")
 end
+function ____exports.gridEntities(self)
+    local gridEntityTypes = getEnumValues(nil, GridEntityType)
+    local gridEntityTypeIndex = -1
+    do
+        local y = 0
+        while y <= 6 do
+            do
+                local x = 0
+                while x <= 12 do
+                    gridEntityTypeIndex = gridEntityTypeIndex + 1
+                    local gridEntityType = gridEntityTypes[gridEntityTypeIndex + 1]
+                    if gridEntityType == nil then
+                        return
+                    end
+                    local position = gridCoordinatesToWorldPosition(nil, x, y)
+                    spawnGrid(nil, gridEntityType, position)
+                    x = x + 1
+                end
+            end
+            y = y + 1
+        end
+    end
+end
 function ____exports.h(self, params)
     ____exports.hearts(nil, params)
 end

package/{dist/features → features}/extraConsoleCommands/commandsDisplay.lua

@@ -1,23 +1,23 @@
 local ____exports = {}
-local ____debugDisplay = require("features.debugDisplay")
-local toggleBombDisplay = ____debugDisplay.toggleBombDisplay
-local toggleDoorDisplay = ____debugDisplay.toggleDoorDisplay
-local toggleEffectDisplay = ____debugDisplay.toggleEffectDisplay
-local toggleFamiliarDisplay = ____debugDisplay.toggleFamiliarDisplay
-local toggleKnifeDisplay = ____debugDisplay.toggleKnifeDisplay
-local toggleLaserDisplay = ____debugDisplay.toggleLaserDisplay
-local toggleNPCDisplay = ____debugDisplay.toggleNPCDisplay
-local togglePickupDisplay = ____debugDisplay.togglePickupDisplay
-local togglePitDisplay = ____debugDisplay.togglePitDisplay
-local togglePlayerDisplay = ____debugDisplay.togglePlayerDisplay
-local togglePoopDisplay = ____debugDisplay.togglePoopDisplay
-local togglePressurePlateDisplay = ____debugDisplay.togglePressurePlateDisplay
-local toggleProjectileDisplay = ____debugDisplay.toggleProjectileDisplay
-local toggleRockDisplay = ____debugDisplay.toggleRockDisplay
-local toggleSlotDisplay = ____debugDisplay.toggleSlotDisplay
-local toggleSpikesDisplay = ____debugDisplay.toggleSpikesDisplay
-local toggleTearDisplay = ____debugDisplay.toggleTearDisplay
-local toggleTNTDisplay = ____debugDisplay.toggleTNTDisplay
+local ____exports = require("features.debugDisplay.exports")
+local toggleBombDisplay = ____exports.toggleBombDisplay
+local toggleDoorDisplay = ____exports.toggleDoorDisplay
+local toggleEffectDisplay = ____exports.toggleEffectDisplay
+local toggleFamiliarDisplay = ____exports.toggleFamiliarDisplay
+local toggleKnifeDisplay = ____exports.toggleKnifeDisplay
+local toggleLaserDisplay = ____exports.toggleLaserDisplay
+local toggleNPCDisplay = ____exports.toggleNPCDisplay
+local togglePickupDisplay = ____exports.togglePickupDisplay
+local togglePitDisplay = ____exports.togglePitDisplay
+local togglePlayerDisplay = ____exports.togglePlayerDisplay
+local togglePoopDisplay = ____exports.togglePoopDisplay
+local togglePressurePlateDisplay = ____exports.togglePressurePlateDisplay
+local toggleProjectileDisplay = ____exports.toggleProjectileDisplay
+local toggleRockDisplay = ____exports.toggleRockDisplay
+local toggleSlotDisplay = ____exports.toggleSlotDisplay
+local toggleSpikesDisplay = ____exports.toggleSpikesDisplay
+local toggleTearDisplay = ____exports.toggleTearDisplay
+local toggleTNTDisplay = ____exports.toggleTNTDisplay
 function ____exports.spikesDisplay(self)
     toggleSpikesDisplay(nil)
 end

package/{dist/features → features}/extraConsoleCommands/init.lua

@@ -16,7 +16,7 @@ local ____map = require("functions.map")
 local getMapPartialMatch = ____map.getMapPartialMatch
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
-local ____debugDisplay = require("features.debugDisplay")
+local ____debugDisplay = require("features.debugDisplay.debugDisplay")
 local debugDisplayInit = ____debugDisplay.debugDisplayInit
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
@@ -161,6 +161,7 @@ commandFunctionsMap:set("goldenhearts", commands.goldenHearts)
 commandFunctionsMap:set("goldenkey", commands.goldenKey)
 commandFunctionsMap:set("grid", commands.grid)
 commandFunctionsMap:set("grid2", commands.grid2)
+commandFunctionsMap:set("gridentities", commands.gridEntities)
 commandFunctionsMap:set("h", commands.h)
 commandFunctionsMap:set("hearts", commands.hearts)
 commandFunctionsMap:set("hitboxes", commands.hitboxes)

package/{dist/features → features}/saveDataManager/exports.d.ts

@@ -1,4 +1,4 @@
-import { SaveData } from "../../types/private/SaveData";
+import { SaveData } from "../../types/SaveData";
 /**
  * This is the entry point to the save data manager, a system which provides two major features:
  *
@@ -59,16 +59,16 @@ import { SaveData } from "../../types/private/SaveData";
  *   can possibly run).
  * - Save data is recorded to disk in the `PRE_GAME_EXIT` callback.
  *
- * Note that before using the save data manager, you must call the [[`upgradeMod`]] function.
+ * Note that before using the save data manager, you must call the `upgradeMod` function.
  *
  * If you want the save data manager to load data before the `POST_PLAYER_INIT` callback (i.e. in
- * the main menu), then you should explicitly call the [[`saveDataManagerLoad`]] function. (The save
+ * the main menu), then you should explicitly call the `saveDataManagerLoad` function. (The save
  * data manager cannot do this on its own because it cannot know when your mod features are finished
  * initializing.)
  *
  * Finally, some features may have variables that need to be automatically reset per run/level, but
  * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
- * data.) For these cases, set a special key of "dontSave" alongside "run", "level", and so forth.
+ * data.) For these cases, set the second argument to `() => false`.
  *
  * @param key The name of the file or feature that is submitting data to be managed by the save data
  *            manager. The save data manager will throw an error if the key is already registered.

package/{dist/features → features}/saveDataManager/load.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
-import { SaveData } from "../../types/private/SaveData";
+import { SaveData } from "../../types/SaveData";
 export declare function loadFromDisk(mod: Mod, oldSaveData: LuaTable<string, SaveData>): void;

package/{dist/features → features}/saveDataManager/main.d.ts

@@ -1,3 +1,3 @@
 import { SaveDataKey } from "../../enums/private/SaveDataKey";
-import { SaveData } from "../../types/private/SaveData";
+import { SaveData } from "../../types/SaveData";
 export declare function restoreDefaultSaveData(subscriberName: string, saveData: SaveData, saveDataKey: SaveDataKey): void;

package/{dist/features → features}/saveDataManager/maps.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="typescript-to-lua/language-extensions" />
-import { SaveData } from "../../types/private/SaveData";
+import { SaveData } from "../../types/SaveData";
 /**
  * The save data map is indexed by subscriber name. We use Lua tables instead of TypeScriptToLua
  * Maps for the master map so that we can access the variables via the in-game console when

package/{dist/features → features}/saveDataManager/save.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
-import { SaveData } from "../../types/private/SaveData";
+import { SaveData } from "../../types/SaveData";
 export declare function saveToDisk(mod: Mod, saveDataMap: LuaTable<string, SaveData>, saveDataConditionalFuncMap: Map<string, () => boolean>): void;

package/{dist/functions → functions}/cards.d.ts

@@ -25,7 +25,7 @@ export declare function getCardDescription(card: Card): string;
 export declare function getCardName(card: Card): string;
 export declare function getCardType(card: Card): ItemConfigCardType;
 /**
- * Helper function to get a set of cards matching the type. Also see the [[`CardType`]] enum.
+ * Helper function to get a set of cards matching the type. Also see the `CardType` enum.
  *
  * This function is variadic, meaning that you can you can specify N card types to get a set
  * containing cards that match any of the specified types.