isaacscript-common 6.0.1 → 6.1.0

package/interfaces/CustomStage.d.ts

@@ -0,0 +1,51 @@
+/**
+ * This is the format of a custom stage in the "isaacscript" section of the "tsconfig.json" file.
+ *
+ * The contents of this interface are used to create a "tsconfig-isaacscript-section-schema.json"
+ * schema with the "ts-json-schema-generator" library.
+ *
+ * The contents of this interface are validated at run-time against the schema using the Ajv
+ * library.
+ *
+ * The `CustomStage` interface extends this, adding room metadata.
+ */
+export interface CustomStageTSConfig {
+    /** The name of the custom stage. */
+    name: string;
+    /**
+     * Path to the XML file that contains the rooms for the custom stage (created with Basement
+     * Renovator).
+     */
+    xmlPath: string;
+    /** An arbitrarily chosen prefix in the range of 101-999. */
+    roomVariantPrefix: number;
+    /**
+     * An integer between 1 and 13, corresponding to the `LevelStage` enum. This is the number of the
+     * stage that will be warped to and used as a basis for the stage by the level generation
+     * algorithm.
+     */
+    baseStage: number;
+    /**
+     * An integer between 0 and 5, corresponding to the `StageType` enum. This is the number of the
+     * stage type that will be warped to and used as a basis for the stage by the level generation
+     * algorithm.
+     */
+    baseStageType: number;
+}
+/**
+ * An object that represents a custom stage. The "metadata.lua" file contains an array of these
+ * objects. Besides the room metadata, the data is the same as what is specified inside the
+ * "tsconfig.json" file.
+ */
+export interface CustomStage extends CustomStageTSConfig {
+    roomsMetadata: CustomStageRoomMetadata[];
+}
+/**
+ * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
+ * each room.
+ */
+export interface CustomStageRoomMetadata {
+    variant: number;
+    shape: number;
+    weight: number;
+}

package/interfaces/JSONRoomsFile.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Custom rooms are created with the Basement Renovator program, which outputs XML files and STB
+ * files. A `JSONRoomsFile` object is simply an XML file converted to JSON. (It is useful to have
+ * the room data in JSON format so that it can be directly consumed by TypeScript programs.)
+ *
+ * You can convert your XML files using the following command:
+ *
+ * ```sh
+ * npx convert-xml-to-json foo.xml foo.json
+ * ```
+ */
+export interface JSONRoomsFile {
+    rooms: JSONRooms;
+}
+export interface JSONRooms {
+    room: JSONRoom[];
+}
+/** Part of `JSONRooms`. */
+export interface JSONRoom {
+    $: {
+        /** Needs to be converted to an `int`. */
+        difficulty: string;
+        /** Needs to be converted to an `int`. */
+        height: string;
+        name: string;
+        /** Needs to be converted to an `int`. */
+        shape: string;
+        /** Needs to be converted to an `int`. */
+        subtype: string;
+        /** Needs to be converted to an `int`. */
+        type: string;
+        /** Needs to be converted to an `int`. */
+        variant: string;
+        /** Needs to be converted to a `float`. */
+        weight: string;
+        /** Needs to be converted to an `int`. */
+        width: string;
+    };
+    door: JSONDoor[];
+    spawn: JSONSpawn[];
+}
+/** Part of `JSONRooms`. */
+export interface JSONDoor {
+    $: {
+        /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
+        exists: string;
+        /** Needs to be converted to an `int`. */
+        x: string;
+        /** Needs to be converted to an `int`. */
+        y: string;
+    };
+}
+/** Part of `JSONRooms`. */
+export interface JSONSpawn {
+    $: {
+        /** Needs to be converted to an `int`. */
+        x: string;
+        /** Needs to be converted to an `int`. */
+        y: string;
+    };
+    entity: JSONEntity[];
+}
+/** Part of `JSONRooms`. */
+export interface JSONEntity {
+    $: {
+        /** Needs to be converted to an `int`. */
+        type: string;
+        /** Needs to be converted to an `int`. */
+        variant: string;
+        /** Needs to be converted to an `int`. */
+        subtype: string;
+        /** Needs to be converted to a `float`. */
+        weight: string;
+    };
+}

package/objects/callbackRegisterFunctions.lua

@@ -9,6 +9,8 @@ local ____postBoneExploded = require("callbacks.subscriptions.postBoneExploded")
 local postBombExplodedRegister = ____postBoneExploded.postBombExplodedRegister
 local ____postBoneSwing = require("callbacks.subscriptions.postBoneSwing")
 local postBoneSwingRegister = ____postBoneSwing.postBoneSwingRegister
+local ____postCollectibleEmpty = require("callbacks.subscriptions.postCollectibleEmpty")
+local postCollectibleEmptyRegister = ____postCollectibleEmpty.postCollectibleEmptyRegister
 local ____postCollectibleInitFirst = require("callbacks.subscriptions.postCollectibleInitFirst")
 local postCollectibleInitFirstRegister = ____postCollectibleInitFirst.postCollectibleInitFirstRegister
 local ____postCursedTeleport = require("callbacks.subscriptions.postCursedTeleport")
@@ -171,6 +173,7 @@ ____exports.CALLBACK_REGISTER_FUNCTIONS = {
     [ModCallbackCustom.POST_BOMB_EXPLODED] = postBombExplodedRegister,
     [ModCallbackCustom.POST_BOMB_INIT_LATE] = postBombInitLateRegister,
     [ModCallbackCustom.POST_BONE_SWING] = postBoneSwingRegister,
+    [ModCallbackCustom.POST_COLLECTIBLE_EMPTY] = postCollectibleEmptyRegister,
     [ModCallbackCustom.POST_COLLECTIBLE_INIT_FIRST] = postCollectibleInitFirstRegister,
     [ModCallbackCustom.POST_CURSED_TELEPORT] = postCursedTeleportRegister,
     [ModCallbackCustom.POST_CUSTOM_DOOR_ENTER] = postCustomDoorEnterRegister,

package/package.json

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

package/features/customStage/constants.d.ts

@@ -1,18 +0,0 @@
-import { RoomType } from "isaac-typescript-definitions";
-/**
- * In order to keep the size of the STB file small, we only allow certain room types to be used in
- * IsaacScript custom stages.
- */
-export declare const CUSTOM_STAGE_ILLEGAL_ROOM_TYPES: Set<RoomType>;
-/** StageAPI uses 70000 as a base. */
-export declare const CUSTOM_STAGE_BASE_ROOM_VARIANT = 80000;
-/**
- * - The `RoomShape` enum goes from 1 to 12.
- * - 12 in binary is 1100.
- * - Thus, we need 4 bits to represent `RoomShape`.
- */
-export declare const CUSTOM_STAGE_NUM_ROOM_SHAPE_BITS = 4;
-/**
- * One for each possible door slot. We add one to account for `DoorSlot.LEFT_0` being equal to zero.
- */
-export declare const CUSTOM_STAGE_NUM_DOOR_SLOT_BITS: number;

package/features/customStage/constants.lua

@@ -1,29 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
-local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
-local ____enums = require("functions.enums")
-local getLastEnumValue = ____enums.getLastEnumValue
---- In order to keep the size of the STB file small, we only allow certain room types to be used in
--- IsaacScript custom stages.
-____exports.CUSTOM_STAGE_ILLEGAL_ROOM_TYPES = __TS__New(Set, {
-    RoomType.BOSS_RUSH,
-    RoomType.BLACK_MARKET,
-    RoomType.GREED_EXIT,
-    RoomType.TELEPORTER,
-    RoomType.TELEPORTER_EXIT,
-    RoomType.SECRET_EXIT,
-    RoomType.BLUE
-})
---- StageAPI uses 70000 as a base.
-____exports.CUSTOM_STAGE_BASE_ROOM_VARIANT = 80000
---- - The `RoomShape` enum goes from 1 to 12.
--- - 12 in binary is 1100.
--- - Thus, we need 4 bits to represent `RoomShape`.
-____exports.CUSTOM_STAGE_NUM_ROOM_SHAPE_BITS = 4
---- One for each possible door slot. We add one to account for `DoorSlot.LEFT_0` being equal to zero.
-____exports.CUSTOM_STAGE_NUM_DOOR_SLOT_BITS = getLastEnumValue(nil, DoorSlot) + 1
-return ____exports

package/features/customStage/scripts/generateCustomStageRooms.d.ts

@@ -1,27 +0,0 @@
-/**
- * Since room data is immutable, we need to create an array of empty rooms like the following:
- *
- * ```xml
- * <room variant="80150" name="1x1" type="2" subtype="0" shape="1" width="13" height="7"
- * difficulty="1" weight="0.0">
- *   <door exists="True" x="-1" y="3"/>
- *   <door exists="True" x="6" y="-1"/>
- *   <door exists="True" x="6" y="7"/>
- *   <door exists="True" x="13" y="3"/>
- * </room>
- * ```
- *
- * - We can repeat room variants between different room types.
- * - The `RoomShape` enum goes from 1 to 12.
- *   - 12 in binary is 1100.
- *   - Thus, we need 4 bits to represent `RoomShape`.
- * - There are 8 possible door slots.
- *   - Thus, we need 8 bits to represent `BitFlags<DoorSlot>`.
- *
- * Thus, the room variant has the following sequence:
- * - 4 bits of `RoomShape` + 8 bits of `BitFlags<DoorSlot>`
- *
- * Even though Basement Renovator does not allow setting variants to values above 16 bits, values
- * with 17 bits work fine in-game.
- */
-export declare function generateCustomStageBaseRooms(): void;

package/features/customStage/scripts/generateCustomStageRooms.lua

@@ -1,126 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
-local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
-local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
-local __TS__StringTrim = ____lualib.__TS__StringTrim
-local __TS__StringSplit = ____lualib.__TS__StringSplit
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
-local ____bitwise = require("functions.bitwise")
-local convertBinaryToDecimal = ____bitwise.convertBinaryToDecimal
-local convertDecimalToBinary = ____bitwise.convertDecimalToBinary
-local setToBitFlags = ____bitwise.setToBitFlags
-local ____doors = require("functions.doors")
-local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
-local getDoorSlotsForRoomShape = ____doors.getDoorSlotsForRoomShape
-local getRoomShapeDoorSlotCoordinates = ____doors.getRoomShapeDoorSlotCoordinates
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
-local ____roomShape = require("functions.roomShape")
-local getRoomShapeLayoutSize = ____roomShape.getRoomShapeLayoutSize
-local ____set = require("functions.set")
-local getSetCombinations = ____set.getSetCombinations
-local getSortedSetValues = ____set.getSortedSetValues
-local ____constants = require("features.customStage.constants")
-local CUSTOM_STAGE_BASE_ROOM_VARIANT = ____constants.CUSTOM_STAGE_BASE_ROOM_VARIANT
-local CUSTOM_STAGE_ILLEGAL_ROOM_TYPES = ____constants.CUSTOM_STAGE_ILLEGAL_ROOM_TYPES
-local CUSTOM_STAGE_NUM_DOOR_SLOT_BITS = ____constants.CUSTOM_STAGE_NUM_DOOR_SLOT_BITS
-local CUSTOM_STAGE_NUM_ROOM_SHAPE_BITS = ____constants.CUSTOM_STAGE_NUM_ROOM_SHAPE_BITS
---- Since room data is immutable, we need to create an array of empty rooms like the following:
--- 
--- ```xml
--- <room variant="80150" name="1x1" type="2" subtype="0" shape="1" width="13" height="7"
--- difficulty="1" weight="0.0">
---   <door exists="True" x="-1" y="3"/>
---   <door exists="True" x="6" y="-1"/>
---   <door exists="True" x="6" y="7"/>
---   <door exists="True" x="13" y="3"/>
--- </room>
--- ```
--- 
--- - We can repeat room variants between different room types.
--- - The `RoomShape` enum goes from 1 to 12.
---   - 12 in binary is 1100.
---   - Thus, we need 4 bits to represent `RoomShape`.
--- - There are 8 possible door slots.
---   - Thus, we need 8 bits to represent `BitFlags<DoorSlot>`.
--- 
--- Thus, the room variant has the following sequence:
--- - 4 bits of `RoomShape` + 8 bits of `BitFlags<DoorSlot>`
--- 
--- Even though Basement Renovator does not allow setting variants to values above 16 bits, values
--- with 17 bits work fine in-game.
-function ____exports.generateCustomStageBaseRooms(self)
-    local rooms = {}
-    for ____, roomType in ipairs(getEnumValues(nil, RoomType)) do
-        do
-            if CUSTOM_STAGE_ILLEGAL_ROOM_TYPES:has(roomType) then
-                goto __continue3
-            end
-            for ____, roomShape in ipairs(getEnumValues(nil, RoomShape)) do
-                do
-                    if roomType ~= RoomType.DEFAULT and roomShape ~= RoomShape.SHAPE_1x1 then
-                        goto __continue5
-                    end
-                    local roomShapeBits = convertDecimalToBinary(nil, roomShape, CUSTOM_STAGE_NUM_ROOM_SHAPE_BITS)
-                    local doorSlotsSet = getDoorSlotsForRoomShape(nil, roomShape)
-                    local doorSlots = getSortedSetValues(nil, doorSlotsSet)
-                    local doorSlotFlagsSet = __TS__New(Set)
-                    for ____, doorSlot in ipairs(doorSlots) do
-                        local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
-                        doorSlotFlagsSet:add(doorSlotFlag)
-                    end
-                    local doorSlotFlagCombinations = getSetCombinations(nil, doorSlotFlagsSet, false)
-                    for ____, doorSlotFlagCombination in ipairs(doorSlotFlagCombinations) do
-                        local doorSlotFlags = setToBitFlags(nil, doorSlotFlagCombination)
-                        local doorSlotBits = convertDecimalToBinary(nil, doorSlotFlags, CUSTOM_STAGE_NUM_DOOR_SLOT_BITS)
-                        local ____array_0 = __TS__SparseArrayNew(table.unpack(roomShapeBits))
-                        __TS__SparseArrayPush(
-                            ____array_0,
-                            table.unpack(doorSlotBits)
-                        )
-                        local combinedBits = {__TS__SparseArraySpread(____array_0)}
-                        local roomVariant = CUSTOM_STAGE_BASE_ROOM_VARIANT + convertBinaryToDecimal(nil, combinedBits)
-                        local name = (((("Type: " .. tostring(roomType)) .. ", Shape: ") .. tostring(roomShape)) .. ", DoorSlotFlags: ") .. tostring(doorSlotFlags)
-                        local width, height = table.unpack(getRoomShapeLayoutSize(nil, roomShape))
-                        local roomHeader = ((((((((((("  <room name=\"" .. name) .. "\" type=\"") .. tostring(roomType)) .. "\" variant=\"") .. tostring(roomVariant)) .. "\" subtype=\"0\" shape=\"") .. tostring(roomShape)) .. "\" width=\"") .. tostring(width)) .. "\" height=\"") .. tostring(height)) .. "\" difficulty=\"1\" weight=\"0.0\">\n"
-                        local doors = {}
-                        for ____, doorSlot in ipairs(doorSlots) do
-                            local thisDoorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
-                            local exists = hasFlag(nil, doorSlotFlags, thisDoorSlotFlag)
-                            local existsText = exists and "True" or "False"
-                            local coordinates = getRoomShapeDoorSlotCoordinates(nil, roomShape, doorSlot)
-                            if coordinates == nil then
-                                error(((((((("Failed to get the coordinates for room shape " .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ") and door slot ") .. tostring(DoorSlot[doorSlot])) .. " (") .. tostring(doorSlot)) .. ").")
-                            end
-                            local x, y = table.unpack(coordinates)
-                            local door = ((((("    <door exists=\"" .. existsText) .. "\" x=\"") .. tostring(x)) .. "\" y=\"") .. tostring(y)) .. "\" />\n"
-                            doors[#doors + 1] = door
-                        end
-                        local doorsXML = table.concat(doors, "")
-                        local roomFooter = "  </room>\n"
-                        local room = (roomHeader .. doorsXML) .. roomFooter
-                        rooms[#rooms + 1] = room
-                    end
-                end
-                ::__continue5::
-            end
-        end
-        ::__continue3::
-    end
-    local xml = table.concat({
-        __TS__StringTrim(("\n<?xml version=\"1.0\" ?>\n<rooms>\n" .. table.concat(rooms, "")) .. "\n</rooms>"),
-        "\n"
-    })
-    for ____, line in ipairs(__TS__StringSplit(xml, "\n")) do
-        Isaac.DebugString(line)
-    end
-end
-return ____exports

package/interfaces/CustomStageData.d.ts

@@ -1,5 +0,0 @@
-import { LevelStage } from "isaac-typescript-definitions";
-export interface CustomStageData {
-    name: string;
-    baseStage: LevelStage;
-}

package/interfaces/JSONDoor.d.ts

@@ -1,11 +0,0 @@
-/** Part of `JSONRooms`. */
-export interface JSONDoor {
-    $: {
-        /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
-        exists: string;
-        /** Needs to be converted to an `int`. */
-        x: string;
-        /** Needs to be converted to an `int`. */
-        y: string;
-    };
-}

package/interfaces/JSONEntity.d.ts

@@ -1,13 +0,0 @@
-/** Part of `JSONRooms`. */
-export interface JSONEntity {
-    $: {
-        /** Needs to be converted to an `int`. */
-        type: string;
-        /** Needs to be converted to an `int`. */
-        variant: string;
-        /** Needs to be converted to an `int`. */
-        subtype: string;
-        /** Needs to be converted to a `float`. */
-        weight: string;
-    };
-}

package/interfaces/JSONEntity.lua

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

package/interfaces/JSONRoom.d.ts

@@ -1,26 +0,0 @@
-import { JSONDoor } from "./JSONDoor";
-import { JSONSpawn } from "./JSONSpawn";
-/** Part of `JSONRooms`. */
-export interface JSONRoom {
-    $: {
-        /** Needs to be converted to an `int`. */
-        difficulty: string;
-        /** Needs to be converted to an `int`. */
-        height: string;
-        name: string;
-        /** Needs to be converted to an `int`. */
-        shape: string;
-        /** Needs to be converted to an `int`. */
-        subtype: string;
-        /** Needs to be converted to an `int`. */
-        type: string;
-        /** Needs to be converted to an `int`. */
-        variant: string;
-        /** Needs to be converted to a `float`. */
-        weight: string;
-        /** Needs to be converted to an `int`. */
-        width: string;
-    };
-    door: JSONDoor[];
-    spawn: JSONSpawn[];
-}

package/interfaces/JSONRoom.lua

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

package/interfaces/JSONRooms.d.ts

@@ -1,11 +0,0 @@
-import { JSONRoom } from "./JSONRoom";
-/**
- * Custom rooms are created with the Basement Renovator program, which outputs XML files and STB
- * files. A `JSONRooms` object is simply an XML file converted to JSON. You can convert your XML
- * files using the following command: `npx convert-xml-to-json foo.xml foo.json`
- */
-export interface JSONRooms {
-    rooms: {
-        room: JSONRoom[];
-    };
-}

package/interfaces/JSONRooms.lua

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

package/interfaces/JSONSpawn.d.ts

@@ -1,11 +0,0 @@
-import { JSONEntity } from "./JSONEntity";
-/** Part of `JSONRooms`. */
-export interface JSONSpawn {
-    $: {
-        /** Needs to be converted to an `int`. */
-        x: string;
-        /** Needs to be converted to an `int`. */
-        y: string;
-    };
-    entity: JSONEntity[];
-}

package/interfaces/JSONSpawn.lua

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