isaacscript-common 3.16.1 → 4.0.1-dev.0

package/constants.ts

@@ -0,0 +1,162 @@
+/**
+ * @module Constants
+ */
+
+import {
+  CollectibleType,
+  Dimension,
+  ItemPoolType,
+  LevelStage,
+  RoomType,
+  TrinketSlot,
+} from "isaac-typescript-definitions";
+import { NUM_NORMAL_PILL_COLORS } from "./constantsFirstLast";
+import { getEnumLength, getLastEnumValue } from "./functions/enums";
+
+/**
+ * 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.
+ */
+export const 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.
+ */
+export const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
+
+/** Bombs explode when their frame count is equal to this value. */
+export const BOMB_EXPLODE_FRAME = 45;
+
+/** This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned. */
+export const COLLECTIBLE_INITIAL_WAIT = 20;
+
+export const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
+
+/** This is also the distance that a player spawns from the door that they enter a room from. */
+export const DISTANCE_OF_GRID_TILE = 40;
+
+export const 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.
+ */
+export const 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.
+ */
+export const 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.
+ */
+export const FIRST_GLITCHED_COLLECTIBLE_TYPE = ((1 << 32) -
+  1) as CollectibleType;
+
+export const GAME_FRAMES_PER_SECOND = 30;
+export const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
+export const ISAAC_FRAMES_PER_SECOND = 60;
+
+/**
+ * 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.
+ */
+export const 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.
+ */
+export const LEVEL_GRID_ROW_WIDTH = 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. The maximum room index possible is 168. (It is not 169 because we start at 0 instead of 1.)
+ */
+export const 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.
+ */
+export const MAX_NUM_FAMILIARS = 64;
+
+/** The game can only handle up to four different players. */
+export const MAX_NUM_INPUTS = 4;
+
+/** With Birthright, it is possible for Magdalene to have 18 heart containers. */
+export const 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.
+ */
+export const MAX_PLAYER_SPEED_IN_UNITS = 9.8;
+
+export const MAX_PLAYER_TRINKET_SLOTS = getEnumLength(TrinketSlot);
+
+/** If you set `EntityPlayer.ShotSpeed` lower than this value, it will have no effect. */
+export const MIN_PLAYER_SHOT_SPEED_STAT = 0.6;
+
+/** If you set `EntityPlayer.Speed` lower than this value, it will have no effect. */
+export const MIN_PLAYER_SPEED_STAT = 0.1;
+
+export const FIRST_ROOM_TYPE = RoomType.DEFAULT; // eslint-disable-line sort-exports/sort-exports
+export const LAST_ROOM_TYPE = getLastEnumValue(RoomType);
+
+/**
+ * The maximum speed stat that a player can have. Any additional speed beyond this will not take
+ * effect.
+ */
+export const MAX_SPEED_STAT = 2.0;
+
+export const FIRST_STAGE = LevelStage.BASEMENT_1; // eslint-disable-line sort-exports/sort-exports
+export const LAST_STAGE = getLastEnumValue(LevelStage);
+
+/** Corresponds to the maximum value for `EntityPlayer.SamsonBerserkCharge`. */
+export const MAX_TAINTED_SAMSON_BERSERK_CHARGE = 100000;
+
+export const NUM_DIMENSIONS = getEnumLength(Dimension) - 1; // Account for "Dimension.CURRENT"
+
+/**
+ * The pill pool for each run is comprised of one effect for each unique pill color (minus gold and
+ * horse pills.)
+ */
+export const NUM_PILLS_IN_POOL = NUM_NORMAL_PILL_COLORS;
+
+export const SECOND_IN_MILLISECONDS = 1000;
+export const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS; // eslint-disable-line sort-exports/sort-exports
+
+export const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
+
+/** After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount. */
+export const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
+
+/**
+ * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
+ * corner.
+ */
+export const UI_HEART_WIDTH = 12;
+
+/**
+ * This is a safer version of the `Vector.One` constant. (Other mods can mutate this `Vector.One`,
+ * so it is not safe to use.)
+ */
+export const VectorOne: Readonly<Vector> = Vector(1, 1);
+
+/**
+ * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`
+ * vector, so it is not safe to use.)
+ */
+export const VectorZero: Readonly<Vector> = Vector(0, 0);

package/constantsFirstLast.ts

@@ -0,0 +1,217 @@
+/* eslint-disable sort-exports/sort-exports */
+
+// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
+/**
+ * @module Constants (First and Last)
+ */
+
+import {
+  Card,
+  CollectibleType,
+  PillColor,
+  PillEffect,
+  PlayerType,
+  TrinketType,
+} from "isaac-typescript-definitions";
+import { itemConfig } from "./cachedClasses";
+import { getEnumLength, getLastEnumValue } from "./functions/enums";
+
+// ------------
+// Collectibles
+// ------------
+
+/** Equal to `CollectibleType.SAD_ONION`. */
+export const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
+
+/**
+ * Will change depending on how many modded collectibles there are.
+ *
+ * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles. We
+ * subtract one to account for `CollectibleType.NULL`.)
+ */
+export const LAST_COLLECTIBLE_TYPE = (itemConfig.GetCollectibles().Size -
+  1) as CollectibleType;
+
+/**
+ * Calculated from the `CollectibleType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because unlike all of the other
+ * enums, collectible types are not contiguous.
+ */
+export const LAST_VANILLA_COLLECTIBLE_TYPE = getLastEnumValue(CollectibleType);
+
+/**
+ * If there are no modded collectibles, this constant will represent a collectible type that does
+ * not exist.
+ */
+export const FIRST_MODDED_COLLECTIBLE_TYPE =
+  ((LAST_VANILLA_COLLECTIBLE_TYPE as int) + 1) as CollectibleType;
+
+/** Calculated from the `CollectibleType` enum. `CollectibleType.NULL` is not included. */
+export const NUM_VANILLA_COLLECTIBLE_TYPES = getEnumLength(CollectibleType) - 1;
+
+/** Unlike vanilla collectible types, modded collectible types are always contiguous. */
+export const NUM_MODDED_COLLECTIBLE_TYPES =
+  LAST_COLLECTIBLE_TYPE - LAST_VANILLA_COLLECTIBLE_TYPE;
+
+export const NUM_COLLECTIBLE_TYPES =
+  NUM_VANILLA_COLLECTIBLE_TYPES + NUM_MODDED_COLLECTIBLE_TYPES;
+
+// --------
+// Trinkets
+// --------
+
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
+ * `TrinketType.NULL`.)
+ */
+export const NUM_TRINKET_TYPES = itemConfig.GetTrinkets().Size - 1;
+
+/** Calculated from the `TrinketType` enum. `TrinketType.NULL` is not included. */
+export const NUM_VANILLA_TRINKET_TYPES = getEnumLength(TrinketType) - 1;
+
+export const NUM_MODDED_TRINKET_TYPES =
+  NUM_TRINKET_TYPES - NUM_VANILLA_TRINKET_TYPES;
+
+/** Equal to `TrinketType.SWALLOWED_PENNY`. */
+export const FIRST_TRINKET_TYPE = TrinketType.SWALLOWED_PENNY;
+
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
+ * `TrinketType.NULL`.)
+ */
+export const LAST_TRINKET_TYPE = NUM_TRINKET_TYPES as TrinketType;
+
+/** Calculated from the `TrinketType` enum. */
+export const LAST_VANILLA_TRINKET_TYPE = getLastEnumValue(TrinketType);
+
+/**
+ * If there are no modded trinkets, this constant will represent a trinket type that does not exist.
+ */
+export const FIRST_MODDED_TRINKET_TYPE = ((LAST_VANILLA_TRINKET_TYPE as int) +
+  1) as TrinketType;
+
+// -----
+// Cards
+// -----
+
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+ */
+export const NUM_CARDS = itemConfig.GetCards().Size - 1;
+
+/** Calculated from the `Card` enum. `Card.NULL` is not included. */
+export const NUM_VANILLA_CARDS = getEnumLength(Card) - 1;
+
+export const NUM_MODDED_CARDS = NUM_CARDS - NUM_VANILLA_CARDS;
+
+/** Equal to `Card.FOOL`. */
+export const FIRST_CARD = Card.FOOL;
+
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+ */
+export const LAST_CARD = NUM_CARDS as Card;
+
+/** Calculated from the `Card` enum. */
+export const MAX_VANILLA_CARD = getLastEnumValue(Card);
+
+/** If there are no modded cards, this constant will represent a card that does not exist. */
+export const FIRST_MODDED_CARD = ((MAX_VANILLA_CARD as int) + 1) as Card;
+
+// ------------
+// Pill Effects
+// ------------
+
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
+ * `PillEffect.NULL`.)
+ */
+export const NUM_PILL_EFFECTS = itemConfig.GetPillEffects().Size - 1;
+
+/**
+ * Calculated from the `PillEffect` enum.
+ *
+ * (There is no `PillEffect.NULL` in the custom enum, so we don't have to subtract one here.)
+ */
+export const NUM_VANILLA_PILL_EFFECTS = getEnumLength(PillEffect);
+
+export const NUM_MODDED_PILL_EFFECTS =
+  NUM_PILL_EFFECTS - NUM_VANILLA_PILL_EFFECTS;
+
+/** Equal to `PillEffect.BAD_GAS`. */
+export const FIRST_PILL_EFFECT = PillEffect.BAD_GAS;
+
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
+ * `PillEffect.NULL`.)
+ */
+export const LAST_PILL_EFFECT = NUM_PILL_EFFECTS as PillEffect;
+
+/** Calculated from the `PillEffect` enum. */
+export const LAST_VANILLA_PILL_EFFECT = getLastEnumValue(PillEffect);
+
+/**
+ * If there are no modded pill effects, this constant will represent a pill effect that does not
+ * exist.
+ */
+export const FIRST_MODDED_PILL_EFFECT = ((LAST_VANILLA_PILL_EFFECT as int) +
+  1) as PillEffect;
+
+// -----------
+// Pill Colors
+// -----------
+
+/** Equal to `PillColor.BLUE_BLUE`. */
+export const FIRST_PILL_COLOR = PillColor.BLUE_BLUE;
+
+/**
+ * Equal to `PillColor.WHITE_YELLOW`.
+ *
+ * Note that `PillColor.GOLD` is technically higher, but that is not considered for the purposes of
+ * this constant.
+ */
+export const LAST_NORMAL_PILL_COLOR = PillColor.WHITE_YELLOW;
+
+/** Equal to `PillColor.HORSE_BLUE_BLUE`. */
+export const FIRST_HORSE_PILL_COLOR = PillColor.HORSE_BLUE_BLUE;
+
+/**
+ * Equal to `PillColor.HORSE_WHITE_YELLOW`.
+ *
+ * Note that `PillColor.HORSE_GOLD` is technically higher, but that is not considered for the
+ * purposes of this constant.
+ */
+export const LAST_HORSE_PILL_COLOR = PillColor.HORSE_WHITE_YELLOW;
+
+export const NUM_NORMAL_PILL_COLORS = LAST_NORMAL_PILL_COLOR - FIRST_PILL_COLOR;
+
+// -------
+// Players
+// -------
+
+/** Equal to `PlayerType.ISAAC`. */
+export const FIRST_CHARACTER = PlayerType.ISAAC;
+
+// It is not possible to determine "LAST_PLAYER_TYPE", since there is no associated config.
+
+/** Calculated from the `PlayerType` enum. */
+export const LAST_VANILLA_CHARACTER = getLastEnumValue(PlayerType);
+
+/**
+ * If there are no modded characters, this constant will represent a character that does not exist.
+ */
+export const FIRST_MODDED_CHARACTER = ((LAST_VANILLA_CHARACTER as int) +
+  1) as PlayerType;

package/enums/AmbushType.ts

@@ -0,0 +1,4 @@
+export enum AmbushType {
+  CHALLENGE_ROOM,
+  BOSS_RUSH,
+}

package/enums/HealthType.ts

@@ -0,0 +1,16 @@
+/**
+ * This represents the type of health that is either given or taken away from a player. Note that we
+ * cannot use the `HeartSubType` enum for this purpose this since it has no value for broken hearts
+ * or max hearts.
+ */
+export enum HealthType {
+  RED, // 5.10.1
+  SOUL, // 5.10.3
+  ETERNAL, // 5.10.4
+  BLACK, // 5.10.6
+  GOLDEN, // 5.10.7
+  BONE, // 5.10.11
+  ROTTEN, // 5.10.12
+  BROKEN,
+  MAX_HEARTS,
+}

package/enums/ModCallbackCustom.d.ts

@@ -121,7 +121,7 @@ export declare enum ModCallbackCustom {
      * only fire if the revival type matches the one provided.
      *
      * ```ts
-     * function postCustomRevive(player: EntityPlayer, revivalType: int) {}
+     * function postCustomRevive(player: EntityPlayer, revivalType: int): void {}
      * ```
      */
     POST_CUSTOM_REVIVE = 8,
@@ -133,7 +133,10 @@ export declare enum ModCallbackCustom {
      * only fire if the `DiceFloorSubType` type matches the one provided.
      *
      * ```ts
-     * function postDiceRoomActivated(player: EntityPlayer, diceFloorSubType: DiceFloorSubType) {}
+     * function postDiceRoomActivated(
+     *   player: EntityPlayer,
+     *   diceFloorSubType: DiceFloorSubType,
+     * ): void {}
      * ```
      */
     POST_DICE_ROOM_ACTIVATED = 9,
@@ -281,7 +284,7 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
      *
      * ```ts
-     * function postGreedModeWave(oldWave: int, newWave: int) {}
+     * function postGreedModeWave(oldWave: int, newWave: int): void {}
      * ```
      */
     POST_GREED_MODE_WAVE = 21,
@@ -676,7 +679,7 @@ export declare enum ModCallbackCustom {
      *   player: EntityPlayer,
      *   healthType: HealthType,
      *   difference: int,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_CHANGE_HEALTH = 46,
@@ -694,7 +697,7 @@ export declare enum ModCallbackCustom {
      *   player: EntityPlayer,
      *   oldCharacter: PlayerType,
      *   newCharacter: PlayerType,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_CHANGE_TYPE = 47,
@@ -702,13 +705,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is higher than
      * what it was on the previous frame.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if the player matches the `CollectibleType` provided.
      *
      * ```ts
-     * function postPlayerCollectibleAdded(player: EntityPlayer, collectibleType: CollectibleType) {}
+     * function postPlayerCollectibleAdded(
+     *   player: EntityPlayer,
+     *   collectibleType: CollectibleType,
+     * ): void {}
      * ```
      */
     POST_PLAYER_COLLECTIBLE_ADDED = 48,
@@ -716,16 +720,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is lower than
      * what it was on the previous frame.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if the player matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleRemoved(
      *   player: EntityPlayer,
      *   collectibleType: CollectibleType,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_COLLECTIBLE_REMOVED = 49,
@@ -742,7 +744,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function postPlayerFatalDamage(player: EntityPlayer) {}
+     * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
     POST_PLAYER_FATAL_DAMAGE = 50,
@@ -1128,7 +1130,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function preBerserkDeath(player: EntityPlayer) {}
+     * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
     PRE_BERSERK_DEATH = 78,
@@ -1146,7 +1148,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function preCustomRevive(player: EntityPlayer) {}
+     * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
     PRE_CUSTOM_REVIVE = 79,