isaacscript-common 21.9.0 → 23.0.0

package/src/functions/players.ts

@@ -24,6 +24,21 @@ import {
 import { isNumber } from "./types";
 import { repeat } from "./utils";
 
+/**
+ * Helper function to add one or more collectibles to a player.
+ *
+ * This function is variadic, meaning that you can supply as many collectible types as you want to
+ * add.
+ */
+export function addCollectible(
+  player: EntityPlayer,
+  ...collectibleTypes: CollectibleType[]
+): void {
+  for (const collectibleType of collectibleTypes) {
+    player.AddCollectible(collectibleType);
+  }
+}
+
 export function addCollectibleCostume(
   player: EntityPlayer,
   collectibleType: CollectibleType,
@@ -438,6 +453,34 @@ export function getTotalPlayerCollectibles(
   return sumArray(numCollectiblesArray);
 }
 
+/**
+ * Helper function to check to see if a player has one or more collectibles.
+ *
+ * This function is variadic, meaning that you can supply as many collectible types as you want to
+ * check for. Returns true if the player has any of the supplied collectible types.
+ */
+export function hasCollectible(
+  player: EntityPlayer,
+  ...collectibleTypes: CollectibleType[]
+): boolean {
+  return collectibleTypes.some((collectibleType) =>
+    player.HasCollectible(collectibleType),
+  );
+}
+
+/**
+ * Helper function to check to see if a player has one or more transformations.
+ *
+ * This function is variadic, meaning that you can supply as many transformations as you want to
+ * check for. Returns true if the player has any of the supplied transformations.
+ */
+export function hasForm(
+  player: EntityPlayer,
+  ...playerForms: PlayerForm[]
+): boolean {
+  return playerForms.some((playerForm) => player.HasPlayerForm(playerForm));
+}
+
 /** After touching a white fire, a player will turn into The Lost until they clear a room. */
 export function hasLostCurse(player: EntityPlayer): boolean {
   const effects = player.GetEffects();
@@ -565,6 +608,17 @@ export function isLost(player: EntityPlayer): boolean {
   return character === PlayerType.LOST || character === PlayerType.LOST_B;
 }
 
+function isTaintedModded(player: EntityPlayer) {
+  // This algorithm only works for modded characters because the `Isaac.GetPlayerTypeByName` method
+  // is bugged.
+  // https://github.com/Meowlala/RepentanceAPIIssueTracker/issues/117
+  const character = player.GetPlayerType();
+  const name = player.GetName();
+  const taintedCharacter = Isaac.GetPlayerTypeByName(name, true);
+
+  return character === taintedCharacter;
+}
+
 export function isModdedPlayer(player: EntityPlayer): boolean {
   return !isVanillaPlayer(player);
 }
@@ -588,17 +642,6 @@ export function isTainted(player: EntityPlayer): boolean {
     : isTaintedModded(player);
 }
 
-function isTaintedModded(player: EntityPlayer) {
-  // This algorithm only works for modded characters because the `Isaac.GetPlayerTypeByName` method
-  // is bugged.
-  // https://github.com/Meowlala/RepentanceAPIIssueTracker/issues/117
-  const character = player.GetPlayerType();
-  const name = player.GetName();
-  const taintedCharacter = Isaac.GetPlayerTypeByName(name, true);
-
-  return character === taintedCharacter;
-}
-
 /** Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus. */
 export function isTaintedLazarus(player: EntityPlayer): boolean {
   const character = player.GetPlayerType();
@@ -613,49 +656,6 @@ export function isVanillaPlayer(player: EntityPlayer): boolean {
   return isVanillaCharacter(character);
 }
 
-/**
- * Helper function to add one or more collectibles to a player.
- *
- * This function is variadic, meaning that you can supply as many collectible types as you want to
- * add.
- */
-export function playerAddCollectible(
-  player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
-): void {
-  for (const collectibleType of collectibleTypes) {
-    player.AddCollectible(collectibleType);
-  }
-}
-
-/**
- * Helper function to check to see if a player has one or more collectibles.
- *
- * This function is variadic, meaning that you can supply as many collectible types as you want to
- * check for. Returns true if the player has any of the supplied collectible types.
- */
-export function playerHasCollectible(
-  player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
-): boolean {
-  return collectibleTypes.some((collectibleType) =>
-    player.HasCollectible(collectibleType),
-  );
-}
-
-/**
- * Helper function to check to see if a player has one or more transformations.
- *
- * This function is variadic, meaning that you can supply as many transformations as you want to
- * check for. Returns true if the player has any of the supplied transformations.
- */
-export function playerHasForm(
-  player: EntityPlayer,
-  ...playerForms: PlayerForm[]
-): boolean {
-  return playerForms.some((playerForm) => player.HasPlayerForm(playerForm));
-}
-
 /**
  * Helper function to remove all of the active items from a player. This includes the Schoolbag item
  * and any pocket actives.
@@ -667,11 +667,11 @@ export function removeAllActiveItems(player: EntityPlayer): void {
       continue;
     }
 
-    let hasCollectible: boolean;
+    let stillHasCollectible: boolean;
     do {
       player.RemoveCollectible(collectibleType);
-      hasCollectible = player.HasCollectible(collectibleType);
-    } while (hasCollectible);
+      stillHasCollectible = player.HasCollectible(collectibleType);
+    } while (stillHasCollectible);
   }
 }
 
@@ -696,6 +696,21 @@ export function removeAllPlayerTrinkets(player: EntityPlayer): void {
   }
 }
 
+/**
+ * Helper function to remove one or more collectibles to a player.
+ *
+ * This function is variadic, meaning that you can supply as many collectible types as you want to
+ * remove.
+ */
+export function removeCollectible(
+  player: EntityPlayer,
+  ...collectibleTypes: CollectibleType[]
+): void {
+  for (const collectibleType of collectibleTypes) {
+    player.RemoveCollectible(collectibleType);
+  }
+}
+
 /**
  * Helper function to remove a collectible costume from a player. Use this helper function to avoid
  * having to request the collectible from the item config.

package/src/functions/positionVelocity.ts

@@ -54,7 +54,7 @@ export function findFreePosition(
   startingPosition: Vector,
   avoidActiveEntities = false,
   minimumDistance?: float,
-): Vector {
+): Readonly<Vector> {
   const room = game.GetRoom();
   const heavenDoors = getEffects(
     EffectVariant.HEAVEN_LIGHT_DOOR,

package/src/functions/roomGrid.ts

@@ -22,7 +22,10 @@ import {
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export function gridCoordinatesToWorldPosition(x: int, y: int): Vector {
+export function gridCoordinatesToWorldPosition(
+  x: int,
+  y: int,
+): Readonly<Vector> {
   const gridPosition = Vector(x, y);
   return gridPositionToWorldPosition(gridPosition);
 }
@@ -36,7 +39,7 @@ export function gridCoordinatesToWorldPosition(x: int, y: int): Vector {
 export function gridIndexToGridPosition(
   gridIndex: int,
   roomShape: RoomShape,
-): Vector {
+): Readonly<Vector> {
   const gridWidth = getRoomShapeWidth(roomShape);
 
   const x = (gridIndex % gridWidth) - 1;
@@ -49,7 +52,9 @@ export function gridIndexToGridPosition(
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export function gridPositionToWorldPosition(gridPosition: Vector): Vector {
+export function gridPositionToWorldPosition(
+  gridPosition: Vector,
+): Readonly<Vector> {
   const x = (gridPosition.X + 2) * 40;
   const y = (gridPosition.Y + 4) * 40;
 
@@ -99,7 +104,9 @@ function isValidGridPositionLRoom(gridPosition: Vector, roomShape: RoomShape) {
  *
  * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
  */
-export function worldPositionToGridPosition(worldPos: Vector): Vector {
+export function worldPositionToGridPosition(
+  worldPos: Vector,
+): Readonly<Vector> {
   const x = Math.round(worldPos.X / 40 - 2);
   const y = Math.round(worldPos.Y / 40 - 4);
   return Vector(x, y);
@@ -112,7 +119,9 @@ export function worldPositionToGridPosition(worldPos: Vector): Vector {
  *
  * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
  */
-export function worldPositionToGridPositionFast(worldPos: Vector): Vector {
+export function worldPositionToGridPositionFast(
+  worldPos: Vector,
+): Readonly<Vector> {
   const x = worldPos.X / 40 - 2;
   const y = worldPos.Y / 40 - 4;
   return Vector(x, y);

package/src/functions/ui.ts

@@ -13,7 +13,7 @@ import { copyVector } from "./vector";
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
  * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
-export function getHUDOffsetVector(): Vector {
+export function getHUDOffsetVector(): Readonly<Vector> {
   // Convert e.g. 0.4 to 4.
   const hudOffset = math.floor(Options.HUDOffset * 10);
 
@@ -89,38 +89,38 @@ export function getHeartsUIWidth(): int {
   return width;
 }
 
-export function getScreenBottomCenterPos(): Vector {
+export function getScreenBottomCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X / 2, bottomRight.Y);
 }
 
-export function getScreenBottomLeftPos(): Vector {
+export function getScreenBottomLeftPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(0, bottomRight.Y);
 }
 
-export function getScreenBottomRightPos(): Vector {
+export function getScreenBottomRightPos(): Readonly<Vector> {
   const screenWidth = Isaac.GetScreenWidth();
   const screenHeight = Isaac.GetScreenHeight();
 
   return Vector(screenWidth, screenHeight);
 }
 
-export function getScreenCenterPos(): Vector {
+export function getScreenCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return bottomRight.div(2);
 }
 
-export function getScreenTopCenterPos(): Vector {
+export function getScreenTopCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X / 2, 0);
 }
 
-export function getScreenTopLeftPos(): Vector {
+export function getScreenTopLeftPos(): Readonly<Vector> {
   return copyVector(VectorZero);
 }
 
-export function getScreenTopRightPos(): Vector {
+export function getScreenTopRightPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X, 0);
 }

package/src/functions/vector.ts

@@ -90,7 +90,7 @@ export function doesVectorHaveLength(
  */
 export function getRandomVector(
   seedOrRNG: Seed | RNG = getRandomSeed(),
-): Vector {
+): Readonly<Vector> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const x = getRandomFloat(-1, 1, rng);

package/src/objects/characterStartingCollectibles.ts

@@ -0,0 +1,144 @@
+import { CollectibleType, PlayerType } from "isaac-typescript-definitions";
+
+export const CHARACTER_STARTING_COLLECTIBLES = {
+  // -1
+  [PlayerType.POSSESSOR]: [],
+
+  // 0
+  [PlayerType.ISAAC]: [CollectibleType.D6],
+
+  // 1
+  [PlayerType.MAGDALENE]: [CollectibleType.YUM_HEART],
+
+  // 2
+  [PlayerType.CAIN]: [CollectibleType.LUCKY_FOOT],
+
+  // 3
+  [PlayerType.JUDAS]: [CollectibleType.BOOK_OF_BELIAL],
+
+  // 4
+  [PlayerType.BLUE_BABY]: [CollectibleType.POOP],
+
+  // 5
+  [PlayerType.EVE]: [
+    CollectibleType.DEAD_BIRD, // 117
+    CollectibleType.WHORE_OF_BABYLON, // 122
+    CollectibleType.RAZOR_BLADE, // 126
+  ],
+
+  // 6
+  [PlayerType.SAMSON]: [CollectibleType.BLOODY_LUST],
+
+  // 7
+  [PlayerType.AZAZEL]: [],
+
+  // 8
+  [PlayerType.LAZARUS]: [CollectibleType.ANEMIC],
+  // (Lazarus Rags is not granted; the extra life is innate.)
+
+  // 9
+  [PlayerType.EDEN]: [],
+
+  // 10
+  [PlayerType.LOST]: [CollectibleType.ETERNAL_D6],
+  // (Holy Mantle is not granted; the effect is innate.)
+
+  // 11
+  [PlayerType.LAZARUS_2]: [CollectibleType.ANEMIC],
+  // (Even if the run is started as Lazarus 2 using e.g. `restart 11`, Anemic is still granted.)
+
+  // 12
+  [PlayerType.DARK_JUDAS]: [],
+
+  // 13
+  [PlayerType.LILITH]: [
+    CollectibleType.BOX_OF_FRIENDS, // 357
+    CollectibleType.CAMBION_CONCEPTION, // 412
+  ],
+
+  // 14
+  [PlayerType.KEEPER]: [CollectibleType.WOODEN_NICKEL],
+
+  // 15
+  [PlayerType.APOLLYON]: [CollectibleType.VOID],
+
+  // 16
+  [PlayerType.FORGOTTEN]: [],
+
+  // 17
+  [PlayerType.SOUL]: [],
+
+  // 18
+  [PlayerType.BETHANY]: [CollectibleType.BOOK_OF_VIRTUES],
+
+  // 19
+  [PlayerType.JACOB]: [],
+
+  // 20
+  [PlayerType.ESAU]: [],
+
+  // 21
+  [PlayerType.ISAAC_B]: [],
+
+  // 22
+  [PlayerType.MAGDALENE_B]: [CollectibleType.YUM_HEART],
+
+  // 23
+  [PlayerType.CAIN_B]: [CollectibleType.BAG_OF_CRAFTING],
+
+  // 24
+  [PlayerType.JUDAS_B]: [CollectibleType.DARK_ARTS],
+
+  // 25
+  [PlayerType.BLUE_BABY_B]: [CollectibleType.HOLD],
+
+  // 26
+  [PlayerType.EVE_B]: [CollectibleType.SUMPTORIUM],
+
+  // 27
+  [PlayerType.SAMSON_B]: [],
+  // (Berserk is not granted; the rage is innate.)
+
+  // 28
+  [PlayerType.AZAZEL_B]: [],
+
+  // 29
+  [PlayerType.LAZARUS_B]: [CollectibleType.FLIP],
+
+  // 30
+  [PlayerType.EDEN_B]: [],
+
+  // 31
+  [PlayerType.LOST_B]: [],
+
+  // 32
+  [PlayerType.LILITH_B]: [],
+
+  // 33
+  [PlayerType.KEEPER_B]: [],
+
+  // 34
+  [PlayerType.APOLLYON_B]: [CollectibleType.ABYSS],
+
+  // 35
+  [PlayerType.FORGOTTEN_B]: [],
+
+  // 36
+  [PlayerType.BETHANY_B]: [CollectibleType.LEMEGETON],
+
+  // 37
+  [PlayerType.JACOB_B]: [CollectibleType.ANIMA_SOLA],
+
+  // 38
+  [PlayerType.LAZARUS_2_B]: [CollectibleType.FLIP],
+  // (Even if the run is started as Dead Tainted Lazarus using e.g. `restart 38`, Flip is still
+  // granted.)
+
+  // 39
+  [PlayerType.JACOB_2_B]: [CollectibleType.ANIMA_SOLA],
+  // (Even if the run is started as Tainted Jacob in "Lost" form using e.g. `restart 39`, Anima Sola
+  // is still granted.)
+
+  // 40
+  [PlayerType.SOUL_B]: [],
+} as const satisfies Record<PlayerType, readonly CollectibleType[]>;