isaacscript-common 14.2.0 → 15.0.0

package/src/features/playerInventory.ts

@@ -1,110 +0,0 @@
-import { CollectibleType } from "isaac-typescript-definitions";
-import { DefaultMap } from "../classes/DefaultMap";
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import {
-  arrayRemoveInPlace,
-  copyArray,
-  getLastElement,
-} from "../functions/array";
-import { isActiveCollectible } from "../functions/collectibles";
-import { defaultMapGetPlayer } from "../functions/playerDataStructures";
-import { PlayerIndex } from "../types/PlayerIndex";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "playerInventory";
-
-const v = {
-  run: {
-    playersInventory: new DefaultMap<
-      PlayerIndex,
-      CollectibleType[],
-      [player: EntityPlayer]
-    >(() => []),
-  },
-};
-
-/** @internal */
-export function playerInventoryInit(mod: ModUpgraded): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED,
-    postCollectibleAdded,
-  );
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED,
-    postCollectibleRemoved,
-  );
-}
-
-// ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED
-function postCollectibleAdded(
-  player: EntityPlayer,
-  collectibleType: CollectibleType,
-) {
-  const inventory = defaultMapGetPlayer(v.run.playersInventory, player, player);
-  inventory.push(collectibleType);
-}
-
-// ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED
-function postCollectibleRemoved(
-  player: EntityPlayer,
-  collectibleType: CollectibleType,
-) {
-  const inventory = defaultMapGetPlayer(v.run.playersInventory, player, player);
-  arrayRemoveInPlace(inventory, collectibleType);
-}
-
-/**
- * Helper function to get all of the collectibles that the player has gotten so far on this run, in
- * order.
- *
- * In the case of inventory initialization or the case where the player rerolls their build in the
- * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
- * that the items were actually given to the player. In this case, the inventory will be in the
- * order of the lowest `CollectibleType` to the highest.
- *
- * Under the hood, the inventory tracking works by tracking the number of collectibles that a player
- * has on every frame. Thus, in a situation where a collectible was both added and removed to the
- * player on the same frame, the amount of total collectibles would stay the same, and the inventory
- * would not be updated. In vanilla, this situation would never happen, but another mod might do
- * this for some reason. (With that said, the next time that a collectible is normally added or
- * removed, it would trigger a re-scan, and the previous changes would be picked up.)
- *
- * @param player The player to get the inventory for.
- * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
- *                                 is true.
- */
-export function getPlayerInventory(
-  player: EntityPlayer,
-  includeActiveCollectibles = true,
-): CollectibleType[] {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  const inventory = defaultMapGetPlayer(v.run.playersInventory, player, player);
-
-  if (includeActiveCollectibles) {
-    return copyArray(inventory);
-  }
-
-  return inventory.filter(
-    (collectibleType) => !isActiveCollectible(collectibleType),
-  );
-}
-
-/**
- * Helper function to get the last passive collectible that the player picked up. In most cases,
- * this will be the passive that is removed when the player would use Clicker.
- *
- * Returns undefined if the player does not have any passive collectibles.
- */
-export function getPlayerLastPassiveCollectible(
-  player: EntityPlayer,
-): CollectibleType | undefined {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  const inventory = getPlayerInventory(player, false);
-  return getLastElement(inventory);
-}

package/src/features/ponyDetection.ts

@@ -1,86 +0,0 @@
-// Detecting whether or not A Pony or White Pony is active is difficult with the vanilla API.
-// Normally, activation will cause the player to have the respective temporary collectible effect
-// However, this effect is lost if the player enters a new room (but the effect will still be
-// active). When the effect is active, the player will have some specific entity flags. Thus, we can
-// work around the problem by checking to see if the player has these entity flags and has had a
-// collectible effect on a previous frame.
-
-import { CollectibleType, EntityFlag } from "isaac-typescript-definitions";
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { hasFlag } from "../functions/flag";
-import {
-  setAddPlayer,
-  setDeletePlayer,
-  setHasPlayer,
-} from "../functions/playerDataStructures";
-import { getPlayers } from "../functions/playerIndex";
-import { PlayerIndex } from "../types/PlayerIndex";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "ponyDetection";
-
-const FLAGS_WHEN_PONY_IS_ACTIVE: readonly EntityFlag[] = [
-  EntityFlag.NO_KNOCKBACK, // 1 << 26
-  EntityFlag.NO_PHYSICS_KNOCKBACK, // 1 << 30
-  EntityFlag.NO_DAMAGE_BLINK, // 1 << 36
-];
-
-const v = {
-  run: {
-    playersIsPonyActive: new Set<PlayerIndex>(),
-  },
-};
-
-/** @internal */
-export function ponyDetectionInit(mod: ModUpgraded): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED,
-    postPEffectUpdateReordered,
-  );
-}
-
-// ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED
-function postPEffectUpdateReordered(player: EntityPlayer) {
-  const effects = player.GetEffects();
-  const entityFlags = player.GetEntityFlags();
-  const hasPonyCollectibleEffect =
-    effects.HasCollectibleEffect(CollectibleType.PONY) ||
-    effects.HasCollectibleEffect(CollectibleType.WHITE_PONY);
-  const isPonyActiveOnPreviousFrame = setHasPlayer(
-    v.run.playersIsPonyActive,
-    player,
-  );
-  const hasPonyFlags = hasFlag(entityFlags, ...FLAGS_WHEN_PONY_IS_ACTIVE);
-
-  const isPonyActiveNow =
-    hasPonyCollectibleEffect || (isPonyActiveOnPreviousFrame && hasPonyFlags);
-  if (isPonyActiveNow) {
-    setAddPlayer(v.run.playersIsPonyActive, player);
-  } else {
-    setDeletePlayer(v.run.playersIsPonyActive, player);
-  }
-}
-
-/**
- * Helper function to see if the player is under the effects of A Pony or White Pony charge.
- * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
- */
-export function isPlayerUsingPony(player: EntityPlayer): boolean {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-  return setHasPlayer(v.run.playersIsPonyActive, player);
-}
-
-/**
- * Helper function to see if any player is under the effects of A Pony or White Pony charge.
- * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
- */
-export function anyPlayerUsingPony(): boolean {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  const players = getPlayers();
-  return players.some((player) => isPlayerUsingPony(player));
-}

package/src/features/preventChildEntities.ts

@@ -1,45 +0,0 @@
-import { ModCallback } from "isaac-typescript-definitions";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "preventChildEntities";
-
-const v = {
-  room: {
-    preventingEntities: new Set<PtrHash>(),
-  },
-};
-
-/** @internal */
-export function preventChildEntitiesInit(mod: Mod): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallback(ModCallback.POST_NPC_INIT, postNPCInit); // 27
-}
-
-// ModCallback.POST_NPC_INIT (27)
-function postNPCInit(npc: EntityNPC) {
-  const spawnerEntityMatch =
-    npc.SpawnerEntity !== undefined &&
-    v.room.preventingEntities.has(GetPtrHash(npc.SpawnerEntity));
-
-  const parentMatch =
-    npc.Parent !== undefined &&
-    v.room.preventingEntities.has(GetPtrHash(npc.Parent));
-
-  if (spawnerEntityMatch || parentMatch) {
-    npc.Remove();
-  }
-}
-
-/**
- * Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
- * like Squirts. This behavior will only last for the current room.
- *
- * Under the hood, this function will remove any new NPCs spawned that have a `Entity.SpawnerEntity`
- * or `Entity.Parent` value that matches the provided entity. (They are removed during the
- * `POST_NPC_INIT` callback specifically.)
- */
-export function preventChildEntities(entity: Entity): void {
-  const ptrHash = GetPtrHash(entity);
-  v.room.preventingEntities.add(ptrHash);
-}

package/src/features/preventCollectibleRotation.ts

@@ -1,115 +0,0 @@
-// Keep specific items from being affected by the Glitched Crown, Binge Eater, and the Tainted Isaac
-// switching mechanic.
-
-import {
-  CardType,
-  CollectibleType,
-  ModCallback,
-  PickupVariant,
-} from "isaac-typescript-definitions";
-import { game } from "../core/cachedClasses";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { setCollectibleSubType } from "../functions/collectibles";
-import { getEntityID } from "../functions/entities";
-import { isCollectible } from "../functions/pickupVariants";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "preventCollectibleRotation";
-
-const v = {
-  room: {
-    /**
-     * Index is a string containing the grid index and the InitSeed of the collectible.
-     * (e.g. "12,1123579202")
-     *
-     * (We cannot simply use the InitSeed of the collectible because Diplopia can cause multiple
-     * collectibles in the room to have the same InitSeed. However, no two collectibles should ever
-     * be on the same grid index.)
-     *
-     * (We cannot use PtrHash as an index because that stays the same when the item is rolled.)
-     */
-    trackedCollectibles: new Map<string, CollectibleType>(),
-  },
-};
-
-/** @internal */
-export function preventCollectibleRotationInit(mod: Mod): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallback(
-    ModCallback.POST_USE_CARD,
-    useCardSoulOfIsaac,
-    CardType.SOUL_ISAAC,
-  ); // 5
-
-  mod.AddCallback(
-    ModCallback.POST_PICKUP_UPDATE,
-    postPickupUpdateCollectible,
-    PickupVariant.COLLECTIBLE,
-  ); // 35
-}
-
-// ModCallback.POST_USE_CARD (5)
-// Card.SOUL_ISAAC (81)
-function useCardSoulOfIsaac() {
-  // Soul of Isaac causes items to flip. Delete all tracked items (assuming that the player
-  // deliberately wants to roll a quest item).
-  v.room.trackedCollectibles.clear();
-}
-
-// ModCallback.POST_PICKUP_UPDATE (35)
-// PickupVariant.COLLECTIBLE (100)
-function postPickupUpdateCollectible(pickup: EntityPickup) {
-  const collectible = pickup as EntityPickupCollectible;
-
-  // Ignore empty pedestals (i.e. items that have already been taken by the player).
-  if (collectible.SubType === CollectibleType.NULL) {
-    return;
-  }
-
-  const index = getMapIndex(collectible);
-  const trackedCollectibleType = v.room.trackedCollectibles.get(index);
-  if (
-    trackedCollectibleType !== undefined &&
-    collectible.SubType !== trackedCollectibleType
-  ) {
-    // This item has switched, so restore it back to the way it was.
-    setCollectibleSubType(collectible, trackedCollectibleType);
-  }
-}
-
-/**
- * Helper function to prevent a collectible from being affected by Tainted Isaac's rotation
- * mechanic. (This mechanic also happens from Glitched Crown and Binge Eater.) This is useful
- * because quest items that are manually spawned by mods will be automatically be affected by this
- * mechanic.
- *
- * It is required to pass the intended collectible type to this function since it is possible for
- * collectibles to rotate on the first frame that they are spawned.
- */
-export function preventCollectibleRotation(
-  collectible: EntityPickup,
-  collectibleType: CollectibleType,
-): void {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  if (!isCollectible(collectible)) {
-    const entityID = getEntityID(collectible);
-    error(
-      `The "preventCollectibleRotate" function was given a non-collectible: ${entityID}`,
-    );
-  }
-
-  const index = getMapIndex(collectible);
-  v.room.trackedCollectibles.set(index, collectibleType);
-
-  // The item might have already shifted on the first frame that it spawns, so change it back if
-  // necessary.
-  postPickupUpdateCollectible(collectible);
-}
-
-function getMapIndex(collectible: EntityPickup) {
-  const room = game.GetRoom();
-  const gridIndex = room.GetGridIndex(collectible.Position);
-  return `${gridIndex},${collectible.InitSeed}`;
-}

package/src/features/roomClearFrame.ts

@@ -1,54 +0,0 @@
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { game } from "../core/cachedClasses";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "roomClearFrame";
-
-const v = {
-  room: {
-    roomClearGameFrame: undefined as int | undefined,
-    roomClearRoomFrame: undefined as int | undefined,
-  },
-};
-
-/** @internal */
-export function roomClearFrameInit(mod: ModUpgraded): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_ROOM_CLEAR_CHANGED,
-    postRoomClearChangedTrue,
-    true,
-  );
-}
-
-// ModCallbackCustom.POST_ROOM_CLEAR_CHANGED
-// true
-function postRoomClearChangedTrue() {
-  const gameFrameCount = game.GetFrameCount();
-  const room = game.GetRoom();
-  const roomFrameCount = room.GetFrameCount();
-
-  v.room.roomClearGameFrame = gameFrameCount;
-  v.room.roomClearRoomFrame = roomFrameCount;
-}
-
-/**
- * Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this room
- * was cleared. Returns undefined if the room has never been cleared.
- */
-export function getRoomClearGameFrame(): int | undefined {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-  return v.room.roomClearGameFrame;
-}
-
-/**
- * Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this room
- * was cleared. Returns undefined if the room has never been cleared.
- */
-export function getRoomClearRoomFrame(): int | undefined {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-  return v.room.roomClearGameFrame;
-}

package/src/features/roomHistory.ts

@@ -1,135 +0,0 @@
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { game } from "../core/cachedClasses";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { getLastElement } from "../functions/array";
-import {
-  getRoomGridIndex,
-  getRoomListIndex,
-  getRoomName,
-  getRoomStageID,
-  getRoomSubType,
-  getRoomVariant,
-  getRoomVisitedCount,
-} from "../functions/roomData";
-import { RoomDescription } from "../interfaces/RoomDescription";
-import { saveDataManager } from "./saveDataManager/exports";
-
-const FEATURE_NAME = "roomHistory";
-
-const v = {
-  run: {
-    roomHistory: [] as RoomDescription[],
-  },
-};
-
-/** @internal */
-export function roomHistoryInit(mod: ModUpgraded): void {
-  saveDataManager(FEATURE_NAME, v);
-
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_NEW_ROOM_EARLY,
-    postNewRoomEarly,
-  );
-}
-
-// ModCallbackCustom.POST_NEW_ROOM_EARLY
-function postNewRoomEarly() {
-  const level = game.GetLevel();
-  const stage = level.GetStage();
-  const stageType = level.GetStageType();
-  const room = game.GetRoom();
-  const roomType = room.GetType();
-  const stageID = getRoomStageID();
-  const roomVariant = getRoomVariant();
-  const roomSubType = getRoomSubType();
-  const roomName = getRoomName();
-  const roomGridIndex = getRoomGridIndex();
-  const roomListIndex = getRoomListIndex();
-  const roomVisitedCount = getRoomVisitedCount();
-
-  const roomDescription: RoomDescription = {
-    stage,
-    stageType,
-    stageID,
-    roomType,
-    roomVariant,
-    roomSubType,
-    roomName,
-    roomGridIndex,
-    roomListIndex,
-    roomVisitedCount,
-  };
-  v.run.roomHistory.push(roomDescription);
-}
-
-/**
- * Helper function to get information about all of the rooms that a player has visited thus far on
- * this run.
- */
-export function getRoomHistory(): readonly RoomDescription[] {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-  return v.run.roomHistory;
-}
-
-/**
- * Helper function to get information about the room that was previously visited.
- *
- * In the special case of only one room having been visited thus far (i.e. the starting room of the
- * run), the starting room will be returned.
- */
-export function getPreviousRoomDescription(): RoomDescription {
-  const previousRoomDescription =
-    v.run.roomHistory[v.run.roomHistory.length - 2];
-  if (previousRoomDescription !== undefined) {
-    return previousRoomDescription;
-  }
-
-  const startingRoomDescription = v.run.roomHistory[0];
-  if (startingRoomDescription !== undefined) {
-    return startingRoomDescription;
-  }
-
-  error(
-    "Failed to find a room description for any rooms thus far on this run.",
-  );
-}
-
-/**
- * Helper function to get information about the most recent room that is stored in the room history
- * array.
- *
- * This is useful in the `POST_ENTITY_REMOVE` callback; see the `isLeavingRoom` function.
- *
- * Note that this function can return undefined in the case where it is called on the first room of
- * the run.
- */
-export function getLatestRoomDescription(): RoomDescription | undefined {
-  return getLastElement(v.run.roomHistory);
-}
-
-/**
- * Helper function to detect if the game is in the state where the room index has changed to a new
- * room, but the entities from the previous room are currently in the process of despawning. (At
- * this point, the `POST_NEW_ROOM` callback will not have fired yet, and there will not be an entry
- * in the room history array for the current room.)
- *
- * This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
- * entity is despawning.
- */
-export function isLeavingRoom(): boolean {
-  const roomListIndex = getRoomListIndex();
-  const roomVisitedCount = getRoomVisitedCount();
-  const latestRoomDescription = getLatestRoomDescription();
-
-  // Sometimes, this function can be called in situations where entities from the previous run are
-  // being despawned. If this is the case, then the room history will currently be empty.
-  if (latestRoomDescription === undefined) {
-    return false;
-  }
-
-  return (
-    roomListIndex !== latestRoomDescription.roomListIndex ||
-    roomVisitedCount !== latestRoomDescription.roomVisitedCount
-  );
-}