isaacscript-common 84.0.1 → 84.1.1

package/dist/core/constants.js

@@ -0,0 +1,289 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TELEPORTER_ACTIVATION_DISTANCE = exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = exports.STARTING_ROOM_GRID_INDEX = exports.RESOLUTION_1600_900 = exports.RESOLUTION_FULL_SCREEN = exports.MINUTE_IN_MILLISECONDS = exports.SECOND_IN_MILLISECONDS = exports.MAX_QUALITY = exports.QUALITIES = exports.ONE_BY_ONE_ROOM_GRID_SIZE = exports.NUM_PILL_COLORS_IN_POOL = exports.DIMENSIONS = exports.NUM_DIMENSIONS = exports.MAX_TAINTED_SAMSON_BERSERK_CHARGE = exports.NEW_RUN_PLAYER_STARTING_POSITION = exports.NEW_FLOOR_STARTING_POSITION_GREED_MODE = exports.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE = exports.MAX_SPEED_STAT = exports.MIN_PLAYER_SPEED_STAT = exports.MIN_PLAYER_SHOT_SPEED_STAT = exports.MAX_PLAYER_TRINKET_SLOTS = exports.MAX_PLAYER_SPEED_IN_UNITS = exports.MAX_PLAYER_HEART_CONTAINERS = exports.MAX_NUM_INPUTS = exports.MAX_NUM_FAMILIARS = exports.MAX_LEVEL_GRID_INDEX = exports.MAPPING_COLLECTIBLES = exports.LEVEL_GRID_ROW_WIDTH = exports.LEVEL_GRID_COLUMN_HEIGHT = exports.GRID_INDEX_CENTER_OF_1X1_ROOM = exports.RENDER_FRAMES_PER_MINUTE = exports.RENDER_FRAMES_PER_SECOND = exports.MAIN_CHARACTERS = exports.GAME_FRAMES_PER_MINUTE = exports.GAME_FRAMES_PER_SECOND = exports.FLYING_CHARACTERS = exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = exports.EMPTY_PNG_PATH = exports.EGGY_STATE_FRAME_OF_FINAL_SPIDER = exports.DOOR_HITBOX_RADIUS = exports.DOGMA_ROOM_GRID_INDEX = exports.DISTANCE_OF_GRID_TILE = exports.DEFAULT_ITEM_POOL_TYPE = exports.COLLECTIBLE_INITIAL_WAIT = exports.CHEST_PICKUP_VARIANTS_SET = exports.CHEST_PICKUP_VARIANTS = exports.BOMB_EXPLODE_FRAME = exports.BLIND_ITEM_PNG_PATH = exports.AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = exports.ALL_DISPLAY_FLAGS = void 0;
+exports.KColorDefault = exports.ColorDefault = exports.VectorZero = exports.VectorOne = exports.UI_HEART_WIDTH = exports.TIME_GAME_OPENED = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const enums_1 = require("../functions/enums");
+const flag_1 = require("../functions/flag");
+const readOnly_1 = require("../functions/readOnly");
+const types_1 = require("../functions/types");
+const utils_1 = require("../functions/utils");
+const ReadonlySet_1 = require("../types/ReadonlySet");
+const constantsFirstLast_1 = require("./constantsFirstLast");
+/**
+ * The combination of the following flags:
+ * - `DisplayFlag.VISIBLE` (1 << 0)
+ * - `DisplayFlag.SHADOW` (1 << 1)
+ * - `DisplayFlag.SHOW_ICON` (1 << 2)
+ */
+exports.ALL_DISPLAY_FLAGS = (0, flag_1.addFlag)(isaac_typescript_definitions_1.DisplayFlag.VISIBLE, isaac_typescript_definitions_1.DisplayFlag.SHADOW, isaac_typescript_definitions_1.DisplayFlag.SHOW_ICON);
+/**
+ * The distance of the laser when Azazel does not have any range up items yet. For more info, see
+ * the documentation for the `getAzazelBrimstoneDistance` function.
+ */
+exports.AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
+/**
+ * The path to the png file for collectible items during Curse of the Blind, making them appear with
+ * a red question mark.
+ */
+exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
+/** Bombs explode when their frame count is equal to this value. */
+exports.BOMB_EXPLODE_FRAME = 45;
+exports.CHEST_PICKUP_VARIANTS = [
+    isaac_typescript_definitions_1.PickupVariant.CHEST,
+    isaac_typescript_definitions_1.PickupVariant.BOMB_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.SPIKED_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.ETERNAL_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.MIMIC_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.OLD_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.WOODEN_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.MEGA_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.HAUNTED_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.LOCKED_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.RED_CHEST,
+    isaac_typescript_definitions_1.PickupVariant.MOMS_CHEST, // 390
+];
+exports.CHEST_PICKUP_VARIANTS_SET = new ReadonlySet_1.ReadonlySet(exports.CHEST_PICKUP_VARIANTS);
+/** This is the initial value of the `EntityPickup.Wait` field after a collectible is spawned. */
+exports.COLLECTIBLE_INITIAL_WAIT = 20;
+exports.DEFAULT_ITEM_POOL_TYPE = isaac_typescript_definitions_1.ItemPoolType.TREASURE;
+/** This is also the distance that a player spawns from the door that they enter a room from. */
+exports.DISTANCE_OF_GRID_TILE = 40;
+exports.DOGMA_ROOM_GRID_INDEX = 109;
+exports.DOOR_HITBOX_RADIUS = 11;
+/**
+ * When Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and spawn 14 Swarm Spiders
+ * while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this
+ * value.
+ */
+exports.EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
+/**
+ * A non-existent or completely transparent PNG file for use in clearing sprites. For more
+ * information, see the documentation for the `clearSprite` helper function.
+ */
+exports.EMPTY_PNG_PATH = "gfx/none.png";
+/**
+ * The random items that appear when the player has TMTRAINER are generated on the fly as they are
+ * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The
+ * second TMTRAINER item subtracts one from that, and so on.
+ *
+ * This is equal to 4294967295.
+ */
+exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (0, types_1.asCollectibleType)((1 << 32) - 1);
+/**
+ * An array containing every flying character. This includes non-main characters such as The Soul.
+ */
+exports.FLYING_CHARACTERS = [
+    isaac_typescript_definitions_1.PlayerType.AZAZEL,
+    isaac_typescript_definitions_1.PlayerType.LOST,
+    isaac_typescript_definitions_1.PlayerType.SOUL,
+    isaac_typescript_definitions_1.PlayerType.LOST_B,
+    isaac_typescript_definitions_1.PlayerType.JACOB_2_B,
+    isaac_typescript_definitions_1.PlayerType.SOUL_B, // 40
+];
+/** Game frames are what is returned by the `Game.GetFrameCount` method. */
+exports.GAME_FRAMES_PER_SECOND = 30;
+/** Game frames are what is returned by the `Game.GetFrameCount` method. */
+exports.GAME_FRAMES_PER_MINUTE = exports.GAME_FRAMES_PER_SECOND * 60;
+/**
+ * An array containing every character that is selectable from the main menu (and has achievements
+ * related to completing the various bosses and so on).
+ */
+exports.MAIN_CHARACTERS = [
+    isaac_typescript_definitions_1.PlayerType.ISAAC,
+    isaac_typescript_definitions_1.PlayerType.MAGDALENE,
+    isaac_typescript_definitions_1.PlayerType.CAIN,
+    isaac_typescript_definitions_1.PlayerType.JUDAS,
+    isaac_typescript_definitions_1.PlayerType.BLUE_BABY,
+    isaac_typescript_definitions_1.PlayerType.EVE,
+    isaac_typescript_definitions_1.PlayerType.SAMSON,
+    isaac_typescript_definitions_1.PlayerType.AZAZEL,
+    isaac_typescript_definitions_1.PlayerType.LAZARUS,
+    isaac_typescript_definitions_1.PlayerType.EDEN,
+    isaac_typescript_definitions_1.PlayerType.LOST,
+    isaac_typescript_definitions_1.PlayerType.LILITH,
+    isaac_typescript_definitions_1.PlayerType.KEEPER,
+    isaac_typescript_definitions_1.PlayerType.APOLLYON,
+    isaac_typescript_definitions_1.PlayerType.FORGOTTEN,
+    isaac_typescript_definitions_1.PlayerType.BETHANY,
+    isaac_typescript_definitions_1.PlayerType.JACOB,
+    isaac_typescript_definitions_1.PlayerType.ISAAC_B,
+    isaac_typescript_definitions_1.PlayerType.MAGDALENE_B,
+    isaac_typescript_definitions_1.PlayerType.CAIN_B,
+    isaac_typescript_definitions_1.PlayerType.JUDAS_B,
+    isaac_typescript_definitions_1.PlayerType.BLUE_BABY_B,
+    isaac_typescript_definitions_1.PlayerType.EVE_B,
+    isaac_typescript_definitions_1.PlayerType.SAMSON_B,
+    isaac_typescript_definitions_1.PlayerType.AZAZEL_B,
+    isaac_typescript_definitions_1.PlayerType.LAZARUS_B,
+    isaac_typescript_definitions_1.PlayerType.EDEN_B,
+    isaac_typescript_definitions_1.PlayerType.LOST_B,
+    isaac_typescript_definitions_1.PlayerType.LILITH_B,
+    isaac_typescript_definitions_1.PlayerType.KEEPER_B,
+    isaac_typescript_definitions_1.PlayerType.APOLLYON_B,
+    isaac_typescript_definitions_1.PlayerType.FORGOTTEN_B,
+    isaac_typescript_definitions_1.PlayerType.BETHANY_B,
+    isaac_typescript_definitions_1.PlayerType.JACOB_B, // 37
+];
+/** Render frames are what is returned by the `Isaac.GetFrameCount` method. */
+exports.RENDER_FRAMES_PER_SECOND = 60;
+/** Render frames are what is returned by the `Isaac.GetFrameCount` method. */
+exports.RENDER_FRAMES_PER_MINUTE = exports.RENDER_FRAMES_PER_SECOND * 60;
+exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
+/**
+ * The floor is represented by a 13x13 grid. Room indexes start at 0. The first column is
+ * represented by grid indexes 0, 13, 26, and so on.
+ */
+exports.LEVEL_GRID_COLUMN_HEIGHT = 13;
+/**
+ * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
+ * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
+ * on.
+ */
+exports.LEVEL_GRID_ROW_WIDTH = 13;
+/**
+ * All of the collectibles that grant vision on the map.
+ *
+ * Note that:
+ * - Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it
+ *   was buffed in Repentance to show rooms two or more away.
+ * - Book of Secrets is included, which is an "active mapping" instead of passive.
+ * - Luna is included, even though it is not a very powerful mapping item.
+ * - Cracked Orb is included, even though it requires the player to be damaged in order for it to be
+ *   activated.
+ */
+exports.MAPPING_COLLECTIBLES = [
+    isaac_typescript_definitions_1.CollectibleType.COMPASS,
+    isaac_typescript_definitions_1.CollectibleType.TREASURE_MAP,
+    isaac_typescript_definitions_1.CollectibleType.SPELUNKER_HAT,
+    isaac_typescript_definitions_1.CollectibleType.CRYSTAL_BALL,
+    isaac_typescript_definitions_1.CollectibleType.BLUE_MAP,
+    isaac_typescript_definitions_1.CollectibleType.BOOK_OF_SECRETS,
+    isaac_typescript_definitions_1.CollectibleType.MIND,
+    isaac_typescript_definitions_1.CollectibleType.SOL,
+    isaac_typescript_definitions_1.CollectibleType.LUNA,
+    isaac_typescript_definitions_1.CollectibleType.CRACKED_ORB, // 675
+];
+/**
+ * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
+ * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
+ * on. The maximum room index possible is 168. (It is not 169 because we start at 0 instead of 1.)
+ */
+exports.MAX_LEVEL_GRID_INDEX = 168;
+/**
+ * The game has a limit on the number of currently spawned familiars and will refuse to spawn any
+ * more if it reaches the limit. Blue flies and blue spiders have a lower priority and will be
+ * deleted to make room for other familiars.
+ */
+exports.MAX_NUM_FAMILIARS = 64;
+/** The game can only handle up to four different players. */
+exports.MAX_NUM_INPUTS = 4;
+/** With Birthright, it is possible for Magdalene to have 18 heart containers. */
+exports.MAX_PLAYER_HEART_CONTAINERS = 18;
+/**
+ * As the player continues to move in a direction, they will accelerate. When going from one wall to
+ * another in a 2x2 room at 2.0 speed (the maximum that the speed stat can rise to), the amount of
+ * units moved per update frame will climb to around 9.797 as they hit the opposite wall. The
+ * constant specifies a value of 9.8 to be safe.
+ */
+exports.MAX_PLAYER_SPEED_IN_UNITS = 9.8;
+exports.MAX_PLAYER_TRINKET_SLOTS = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.TrinketSlot);
+/** If you set `EntityPlayer.ShotSpeed` lower than this value, it will have no effect. */
+exports.MIN_PLAYER_SHOT_SPEED_STAT = 0.6;
+/** If you set `EntityPlayer.Speed` lower than this value, it will have no effect. */
+exports.MIN_PLAYER_SPEED_STAT = 0.1;
+/**
+ * The maximum speed stat that a player can have. Any additional speed beyond this will not take
+ * effect.
+ */
+exports.MAX_SPEED_STAT = 2;
+/** This is in the center of the room. */
+exports.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE = (0, readOnly_1.newReadonlyVector)(320, 280);
+/** This is near the top door. */
+exports.NEW_FLOOR_STARTING_POSITION_GREED_MODE = (0, readOnly_1.newReadonlyVector)(320, 280);
+/**
+ * This is next to the bottom door. Presumably, the player does not start in the center of the room
+ * (like they do when getting to a new stage) so that the controls graphic is more visible.
+ */
+exports.NEW_RUN_PLAYER_STARTING_POSITION = (0, readOnly_1.newReadonlyVector)(320, 380);
+/** Corresponds to the maximum value for `EntityPlayer.SamsonBerserkCharge`. */
+exports.MAX_TAINTED_SAMSON_BERSERK_CHARGE = 100_000;
+/**
+ * The number of dimensions, not including `Dimension.CURRENT`. (This is derived from the
+ * `Dimension` enum.)
+ */
+exports.NUM_DIMENSIONS = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.Dimension) - 1;
+/**
+ * An array containing every valid `Dimension`, not including `Dimension.CURRENT`. (This is derived
+ * from the `NUM_DIMENSIONS` constant.)
+ */
+exports.DIMENSIONS = (0, utils_1.eRange)(exports.NUM_DIMENSIONS);
+/**
+ * The pill pool for each run is comprised of one effect for each unique pill color (minus gold and
+ * horse pills.)
+ */
+// TypeDoc will not work properly with the preferred export form.
+// eslint-disable-next-line unicorn/prefer-export-from
+exports.NUM_PILL_COLORS_IN_POOL = constantsFirstLast_1.NUM_NORMAL_PILL_COLORS;
+exports.ONE_BY_ONE_ROOM_GRID_SIZE = 135;
+/**
+ * An array representing every valid collectible type quality. Specifically, this is: `[0, 1, 2, 3,
+ * 4]`
+ */
+// eslint-disable-next-line isaacscript/require-capital-const-assertions
+exports.QUALITIES = [0, 1, 2, 3, 4];
+exports.MAX_QUALITY = 4;
+exports.SECOND_IN_MILLISECONDS = 1000;
+exports.MINUTE_IN_MILLISECONDS = 60 * exports.SECOND_IN_MILLISECONDS;
+/** This is equivalent to the bottom-right screen position when the game is in full screen mode. */
+exports.RESOLUTION_FULL_SCREEN = Vector(480, 270);
+/**
+ * This is equivalent to the bottom-right screen position when the game is in windowed mode in a
+ * 1600x900 resolution.
+ */
+exports.RESOLUTION_1600_900 = Vector(533, 300);
+/**
+ * The starting room of the floor is always at the same grid index, which is in the middle of the
+ * 13x13 grid.
+ */
+exports.STARTING_ROOM_GRID_INDEX = 84;
+/** After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount. */
+exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10_000;
+/** For `GridEntityType.TELEPORTER` (23). */
+exports.TELEPORTER_ACTIVATION_DISTANCE = exports.DISTANCE_OF_GRID_TILE / 2;
+/** In milliseconds, as reported by the `Isaac.GetTime` method. */
+exports.TIME_GAME_OPENED = Isaac.GetTime();
+/**
+ * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
+ * corner.
+ */
+exports.UI_HEART_WIDTH = 12;
+/**
+ * Equal to `Vector(1, 1)`.
+ *
+ * This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
+ * is not safe to use.)
+ */
+exports.VectorOne = (0, readOnly_1.newReadonlyVector)(1, 1);
+/**
+ * Equal to `Vector(0, 0)`.
+ *
+ * This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
+ * is not safe to use.)
+ */
+exports.VectorZero = (0, readOnly_1.newReadonlyVector)(0, 0);
+/**
+ * Equal to `Color(1, 1, 1)`.
+ *
+ * This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
+ * so it is not safe to use.)
+ *
+ * If you need to mutate this, make a copy first with the `copyColor` helper function.
+ */
+exports.ColorDefault = (0, readOnly_1.newReadonlyColor)(1, 1, 1);
+/**
+ * Equal to `KColor(1, 1, 1, 1)`.
+ *
+ * If you need to mutate this, make a copy first with the `copyKColor` helper function.
+ */
+exports.KColorDefault = (0, readOnly_1.newReadonlyKColor)(1, 1, 1, 1);

package/dist/core/constantsFirstLast.js

@@ -0,0 +1,98 @@
+"use strict";
+/**
+ * Constants relating to the first and last value for various vanilla objects.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NUM_VANILLA_CHALLENGES = exports.LAST_VANILLA_CHARACTER = exports.FIRST_CHARACTER = exports.NUM_NORMAL_PILL_COLORS = exports.LAST_HORSE_PILL_COLOR = exports.FIRST_HORSE_PILL_COLOR = exports.LAST_NORMAL_PILL_COLOR = exports.FIRST_PILL_COLOR = exports.NUM_VANILLA_PILL_EFFECTS = exports.LAST_VANILLA_PILL_EFFECT = exports.FIRST_PILL_EFFECT = exports.NUM_VANILLA_CARD_TYPES = exports.LAST_VANILLA_CARD_TYPE = exports.FIRST_CARD_TYPE = exports.NUM_VANILLA_TRINKET_TYPES = exports.LAST_VANILLA_TRINKET_TYPE = exports.FIRST_TRINKET_TYPE = exports.NUM_VANILLA_COLLECTIBLE_TYPES = exports.LAST_VANILLA_COLLECTIBLE_TYPE = exports.FIRST_COLLECTIBLE_TYPE = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const enums_1 = require("../functions/enums");
+// ------------
+// Collectibles
+// ------------
+/** Equal to `CollectibleType.SAD_ONION` (1). */
+exports.FIRST_COLLECTIBLE_TYPE = isaac_typescript_definitions_1.CollectibleType.SAD_ONION;
+/**
+ * Calculated from the `CollectibleType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because collectible types are
+ * not contiguous.
+ */
+exports.LAST_VANILLA_COLLECTIBLE_TYPE = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.CollectibleType);
+/** Calculated from the `CollectibleType` enum. (`CollectibleType.NULL` is not included.) */
+exports.NUM_VANILLA_COLLECTIBLE_TYPES = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.CollectibleType) - 1;
+// --------
+// Trinkets
+// --------
+/** Equal to `TrinketType.SWALLOWED_PENNY` (1). */
+exports.FIRST_TRINKET_TYPE = isaac_typescript_definitions_1.TrinketType.SWALLOWED_PENNY;
+/**
+ * Calculated from the `TrinketType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because trinket types are not
+ * contiguous.
+ */
+exports.LAST_VANILLA_TRINKET_TYPE = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.TrinketType);
+/** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
+exports.NUM_VANILLA_TRINKET_TYPES = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.TrinketType) - 1;
+// -----
+// Cards
+// -----
+/** Equal to `Card.FOOL` (1). */
+exports.FIRST_CARD_TYPE = isaac_typescript_definitions_1.CardType.FOOL;
+/** Calculated from the `CardType` enum. */
+exports.LAST_VANILLA_CARD_TYPE = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.CardType);
+/** Calculated from the `Card` enum. `Card.NULL` is not included. */
+exports.NUM_VANILLA_CARD_TYPES = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.CardType) - 1;
+// ------------
+// Pill Effects
+// ------------
+/** Equal to `PillEffect.BAD_GAS` (0). */
+exports.FIRST_PILL_EFFECT = isaac_typescript_definitions_1.PillEffect.BAD_GAS;
+/** Calculated from the `PillEffect` enum. */
+exports.LAST_VANILLA_PILL_EFFECT = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.PillEffect);
+/**
+ * Calculated from the `PillEffect` enum. (There is no `PillEffect.NULL` in the custom enum, so we
+ * do not have to subtract one here.)
+ */
+exports.NUM_VANILLA_PILL_EFFECTS = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.PillEffect);
+// -----------
+// Pill Colors
+// -----------
+/** Equal to `PillColor.BLUE_BLUE` (1). */
+exports.FIRST_PILL_COLOR = isaac_typescript_definitions_1.PillColor.BLUE_BLUE;
+/**
+ * Equal to `PillColor.WHITE_YELLOW` (13).
+ *
+ * Note that `PillColor.GOLD` is technically higher, but that is not considered for the purposes of
+ * this constant.
+ */
+exports.LAST_NORMAL_PILL_COLOR = isaac_typescript_definitions_1.PillColor.WHITE_YELLOW;
+/** Equal to `PillColor.HORSE_BLUE_BLUE` (2049). */
+exports.FIRST_HORSE_PILL_COLOR = isaac_typescript_definitions_1.PillColor.HORSE_BLUE_BLUE;
+/**
+ * Equal to `PillColor.HORSE_WHITE_YELLOW` (2061).
+ *
+ * Note that `PillColor.HORSE_GOLD` is technically higher, but that is not considered for the
+ * purposes of this constant.
+ */
+exports.LAST_HORSE_PILL_COLOR = isaac_typescript_definitions_1.PillColor.HORSE_WHITE_YELLOW;
+/**
+ * Calculated from the difference between the first pill color and the last pill color. This does
+ * not include Gold Pills. In Repentance, this should be equal to 13.
+ */
+exports.NUM_NORMAL_PILL_COLORS = exports.LAST_NORMAL_PILL_COLOR - exports.FIRST_PILL_COLOR + 1;
+// -------
+// Players
+// -------
+/** Equal to `PlayerType.ISAAC` (0). */
+exports.FIRST_CHARACTER = isaac_typescript_definitions_1.PlayerType.ISAAC;
+// It is not possible to determine "LAST_PLAYER_TYPE", since there is no associated config.
+/** Calculated from the `PlayerType` enum. */
+exports.LAST_VANILLA_CHARACTER = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.PlayerType);
+// ----------
+// Challenges
+// ----------
+/** Calculated from the `Challenge` enum. `Challenge.NULL` is not included. */
+exports.NUM_VANILLA_CHALLENGES = (0, enums_1.getEnumLength)(isaac_typescript_definitions_1.Challenge) - 1;

package/dist/core/constantsVanilla.js

@@ -0,0 +1,131 @@
+"use strict";
+/**
+ * Constants relating to collections for various vanilla objects.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VANILLA_PILL_EFFECTS_SET = exports.VANILLA_PILL_EFFECTS = exports.VANILLA_PILL_EFFECT_RANGE = exports.VANILLA_CARD_TYPES_SET = exports.VANILLA_CARD_TYPES = exports.VANILLA_CARD_TYPE_RANGE = exports.VANILLA_TRINKET_TYPES_SET = exports.VANILLA_TRINKET_TYPES = exports.VANILLA_TRINKET_TYPE_RANGE = exports.VANILLA_COLLECTIBLE_TYPES_SET = exports.VANILLA_COLLECTIBLE_TYPES = exports.VANILLA_COLLECTIBLE_TYPE_RANGE = void 0;
+const types_1 = require("../functions/types");
+const utils_1 = require("../functions/utils");
+const ReadonlySet_1 = require("../types/ReadonlySet");
+const cachedClasses_1 = require("./cachedClasses");
+const constantsFirstLast_1 = require("./constantsFirstLast");
+// ------------
+// Collectibles
+// ------------
+/**
+ * An array that represents the range from the first vanilla collectible type to the last vanilla
+ * 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 `VANILLA_COLLECTIBLE_TYPES` or `VANILLA_COLLECTIBLE_TYPES_SET` constants instead.
+ */
+exports.VANILLA_COLLECTIBLE_TYPE_RANGE = (0, utils_1.iRange)(constantsFirstLast_1.FIRST_COLLECTIBLE_TYPE, constantsFirstLast_1.LAST_VANILLA_COLLECTIBLE_TYPE);
+/**
+ * An array that contains every valid vanilla collectible type, as verified by the
+ * `ItemConfig.GetCollectible` method. Vanilla collectible types are not contiguous, so every valid
+ * must be verified. (There are several gaps, e.g. 666.)
+ *
+ * If you need to do O(1) lookups, use the `VANILLA_COLLECTIBLE_TYPES_SET` constant instead.
+ */
+// eslint-disable-next-line isaacscript/strict-enums
+exports.VANILLA_COLLECTIBLE_TYPES = exports.VANILLA_COLLECTIBLE_TYPE_RANGE.filter((potentialCollectibleType) => {
+    const collectibleType = (0, types_1.asCollectibleType)(potentialCollectibleType);
+    const itemConfigItem = cachedClasses_1.itemConfig.GetCollectible(collectibleType);
+    return itemConfigItem !== undefined;
+});
+/**
+ * A set that contains every valid vanilla collectible type, as verified by the
+ * `ItemConfig.GetCollectible` method. Vanilla collectible types are not contiguous, so every valid
+ * must be verified. (There are several gaps, e.g. 666.)
+ */
+exports.VANILLA_COLLECTIBLE_TYPES_SET = new ReadonlySet_1.ReadonlySet(exports.VANILLA_COLLECTIBLE_TYPES);
+// --------
+// Trinkets
+// --------
+/**
+ * An array that represents the range from the first vanilla trinket type to the last vanilla
+ * trinket type. This will include integers that do not represent any valid trinket types.
+ *
+ * This function is only useful when building trinket type objects. For most purposes, you should
+ * use the `VANILLA_TRINKET_TYPES` or `VANILLA_TRINKET_TYPES_SET` constants instead.
+ */
+exports.VANILLA_TRINKET_TYPE_RANGE = (0, utils_1.iRange)(constantsFirstLast_1.FIRST_TRINKET_TYPE, constantsFirstLast_1.LAST_VANILLA_TRINKET_TYPE);
+/**
+ * An array that contains every valid vanilla trinket type, as verified by the
+ * `ItemConfig.GetTrinket` method. Vanilla trinket types are not contiguous, so every valid must be
+ * verified. (The only gap is 47 for `POLAROID_OBSOLETE`.)
+ *
+ * If you need to do O(1) lookups, use the `VANILLA_TRINKET_TYPES_SET` constant instead.
+ */
+// eslint-disable-next-line isaacscript/strict-enums
+exports.VANILLA_TRINKET_TYPES = exports.VANILLA_TRINKET_TYPE_RANGE.filter((potentialTrinketType) => {
+    const trinketType = (0, types_1.asTrinketType)(potentialTrinketType);
+    const itemConfigTrinket = cachedClasses_1.itemConfig.GetTrinket(trinketType);
+    return itemConfigTrinket !== undefined;
+});
+/**
+ * A set that contains every valid vanilla trinket type, as verified by the `ItemConfig.GetTrinket`
+ * method. Vanilla trinket types are not contiguous, so every valid must be verified. (The only gap
+ * is 47 for `POLAROID_OBSOLETE`.)
+ */
+exports.VANILLA_TRINKET_TYPES_SET = new ReadonlySet_1.ReadonlySet(exports.VANILLA_TRINKET_TYPES);
+// ----------
+// Card Types
+// ----------
+/**
+ * An array that represents the range from the first vanilla card type to the last vanilla card
+ * type.
+ *
+ * This function is only useful when building card type objects. For most purposes, you should use
+ * the `VANILLA_CARD_TYPES` or `VANILLA_CARD_TYPES_SET` constants instead.
+ */
+exports.VANILLA_CARD_TYPE_RANGE = (0, utils_1.iRange)(constantsFirstLast_1.FIRST_CARD_TYPE, constantsFirstLast_1.LAST_VANILLA_CARD_TYPE);
+/**
+ * An array that contains every valid vanilla card type, as verified by the `ItemConfig.GetCard`
+ * method. Vanilla card types are contiguous, but we validate every entry to double check.
+ *
+ * If you need to do O(1) lookups, use the `VANILLA_CARD_TYPES_SET` constant instead.
+ */
+// eslint-disable-next-line isaacscript/strict-enums
+exports.VANILLA_CARD_TYPES = exports.VANILLA_CARD_TYPE_RANGE.filter((potentialCardType) => {
+    const cardType = (0, types_1.asCardType)(potentialCardType);
+    const itemConfigCard = cachedClasses_1.itemConfig.GetCard(cardType);
+    return itemConfigCard !== undefined;
+});
+/**
+ * A set that contains every valid vanilla card type, as verified by the `ItemConfig.GetCard`
+ * method. Vanilla card types are contiguous, but we validate every entry to double check.
+ */
+exports.VANILLA_CARD_TYPES_SET = new ReadonlySet_1.ReadonlySet(exports.VANILLA_CARD_TYPES);
+// ------------
+// Pill Effects
+// ------------
+/**
+ * An array that represents the range from the first vanilla pill effect to the last vanilla pill
+ * effect.
+ *
+ * This function is only useful when building pill effect objects. For most purposes, you should use
+ * the `VANILLA_PILL_EFFECTS` or `VANILLA_PILL_EFFECTS_SET` constants instead.
+ */
+exports.VANILLA_PILL_EFFECT_RANGE = (0, utils_1.iRange)(constantsFirstLast_1.FIRST_PILL_EFFECT, constantsFirstLast_1.LAST_VANILLA_PILL_EFFECT);
+/**
+ * An array that contains every valid vanilla pill effect, as verified by the
+ * `ItemConfig.GetPillEffect` method. Vanilla pill effects are contiguous, but we validate every
+ * entry to double check.
+ *
+ * If you need to do O(1) lookups, use the `VANILLA_PILL_EFFECT_SET` constant instead.
+ */
+// eslint-disable-next-line isaacscript/strict-enums
+exports.VANILLA_PILL_EFFECTS = exports.VANILLA_PILL_EFFECT_RANGE.filter((potentialPillEffect) => {
+    const pillEffect = (0, types_1.asPillEffect)(potentialPillEffect);
+    const itemConfigPillEffect = cachedClasses_1.itemConfig.GetPillEffect(pillEffect);
+    return itemConfigPillEffect !== undefined;
+});
+/**
+ * A set that contains every valid vanilla pill effect, as verified by the
+ * `ItemConfig.GetPillEffect` method. Vanilla pill effects are contiguous, but we validate every
+ * entry to double check.
+ */
+exports.VANILLA_PILL_EFFECTS_SET = new ReadonlySet_1.ReadonlySet(exports.VANILLA_PILL_EFFECTS);

package/dist/core/upgradeMod.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upgradeMod = void 0;
+const ModUpgraded_1 = require("../classes/ModUpgraded");
+const patchErrorFunctions_1 = require("../patchErrorFunctions");
+const shaderCrashFix_1 = require("../shaderCrashFix");
+/**
+ * Use this function to enable the custom callbacks and other optional features provided by
+ * `isaacscript-common`.
+ *
+ * For example:
+ *
+ * ```ts
+ * const modVanilla = RegisterMod("My Mod", 1);
+ * const mod = upgradeMod(modVanilla);
+ *
+ * // Subscribe to vanilla callbacks.
+ * mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
+ *
+ * // Subscribe to custom callbacks.
+ * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
+ * ```
+ *
+ * @param modVanilla The mod object returned by the `RegisterMod` function.
+ * @param features Optional. An array containing the optional standard library features that you
+ *                 want to enable, if any. Default is an empty array.
+ * @param debug Optional. Whether to log additional output when a callback is fired. Default is
+ *              false.
+ * @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
+ *                      specified number of seconds (if the "--luadebug" launch flag is turned on)
+ *                      or milliseconds (if the "--luadebug" launch flag is turned off).
+ * @returns The upgraded mod object.
+ */
+function upgradeMod(modVanilla, features = [], debug = false, timeThreshold) {
+    // First, validate that all of the features exist (for Lua users who don't have type-safety).
+    for (const feature of features) {
+        const featureType = type(feature);
+        if (featureType !== "number") {
+            error(`Failed to upgrade the mod due to one of the specified features being of type "${featureType}". (All of the features should be numbers represented by the "ISCFeature" enum.)`);
+        }
+    }
+    // Second, validate that all of the features are unique.
+    const featureSet = new Set(features);
+    if (featureSet.size !== features.length) {
+        error('Failed to upgrade the mod since there are two or more of the same features specified in the "features" array. When you pass the array of features to the "upgradeMod" function, all of the elements should be unique.');
+    }
+    (0, patchErrorFunctions_1.patchErrorFunction)();
+    const mod = new ModUpgraded_1.ModUpgraded(modVanilla, debug, timeThreshold);
+    (0, shaderCrashFix_1.applyShaderCrashFix)(mod);
+    initOptionalFeatures(mod, features);
+    return mod;
+}
+exports.upgradeMod = upgradeMod;
+/** Initialize every optional feature that the end-user specified, if any. */
+function initOptionalFeatures(mod, features) {
+    for (const feature of features) {
+        // We intentionally access the private method here, so we use the string index escape hatch:
+        // https://github.com/microsoft/TypeScript/issues/19335
+        // eslint-disable-next-line @typescript-eslint/dot-notation
+        const exportedMethodTuples = mod["initOptionalFeature"](feature);
+        // If the optional feature provides helper functions, attach them to the base mod object. (This
+        // provides a convenient API for end-users.)
+        const modRecord = mod;
+        for (const [funcName, func] of exportedMethodTuples) {
+            if (modRecord[funcName] !== undefined) {
+                error(`Failed to upgrade the mod since two or more features share the name function name of "${funcName}". This should never happen, so report this error to the library authors.`);
+            }
+            modRecord[funcName] = func;
+        }
+    }
+}

package/dist/customStageMetadata.json

@@ -0,0 +1 @@
+[]