isaacscript-common 4.0.2 → 4.0.5

package/functions/charge.ts

@@ -1,237 +0,0 @@
-import {
-  ActiveSlot,
-  CollectibleType,
-  RoomShape,
-  SoundEffect,
-  TrinketType,
-} from "isaac-typescript-definitions";
-import { game, sfxManager } from "../cachedClasses";
-import { getCollectibleMaxCharges } from "./collectibles";
-import { getPlayers } from "./playerIndex";
-
-/**
- * Helper function to add a charge to a player's active item, emulating what happens when a room is
- * cleared.
- *
- * This function will take the following things into account:
- * - L rooms and 2x2 rooms granting a double charge
- * - The Battery
- * - AAA Battery
- *
- * @param player The player to grant the charges to.
- * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- *                                 1x1 room for the purposes of calculating how much charge to
- *                                 grant. Default is false.
- */
-export function addRoomClearCharge(
-  player: EntityPlayer,
-  ignoreBigRoomDoubleCharge = false,
-): void {
-  for (const activeSlot of [
-    ActiveSlot.PRIMARY,
-    ActiveSlot.SECONDARY,
-    ActiveSlot.POCKET,
-  ]) {
-    addRoomClearChargeToSlot(player, activeSlot, ignoreBigRoomDoubleCharge);
-  }
-}
-
-/**
- * Helper function to add a charge to one of a player's active items, emulating what happens when a
- * room is cleared.
- *
- * This function will take the following things into account:
- * - L rooms and 2x2 rooms granting a double charge
- * - The Battery
- * - AAA Battery
- *
- * @param player The player to grant the charges to.
- * @param activeSlot The active item slot to grant the charges to.
- * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- *                                 1x1 room for the purposes of calculating how much charge to
- *                                 grant. Default is false.
- */
-export function addRoomClearChargeToSlot(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-  ignoreBigRoomDoubleCharge = false,
-): void {
-  if (!player.NeedsCharge(activeSlot)) {
-    return;
-  }
-
-  const hud = game.GetHUD();
-
-  // Find out the new charge to set on the item.
-  const totalCharge = getTotalCharge(player, activeSlot);
-  const chargesToAdd = getNumChargesToAdd(
-    player,
-    activeSlot,
-    ignoreBigRoomDoubleCharge,
-  );
-  const modifiedChargesToAdd = getNumChargesWithAAAModifier(
-    player,
-    activeSlot,
-    chargesToAdd,
-  );
-  const newCharge = totalCharge + modifiedChargesToAdd;
-
-  player.SetActiveCharge(newCharge, activeSlot);
-  hud.FlashChargeBar(player, activeSlot);
-
-  playChargeSoundEffect(player, activeSlot);
-}
-
-function getNumChargesToAdd(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-  ignoreBigRoomDoubleCharge = false,
-) {
-  const room = game.GetRoom();
-  const roomShape = room.GetRoomShape();
-  const activeItem = player.GetActiveItem(activeSlot);
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
-  const maxCharges = getCollectibleMaxCharges(activeItem);
-
-  if (!hasBattery && activeCharge === maxCharges) {
-    return 0;
-  }
-
-  if (hasBattery && batteryCharge === maxCharges) {
-    return 0;
-  }
-
-  if (!hasBattery && activeCharge + 1 === maxCharges) {
-    // We are only 1 charge away from a full charge, so only add one charge to avoid an overcharge.
-    // (It is possible to set orange charges without the player actually having The Battery.)
-    return 1;
-  }
-
-  if (hasBattery && batteryCharge + 1 === maxCharges) {
-    // We are only 1 charge away from a full double-charge, so only add one charge to avoid an
-    // overcharge.
-    return 1;
-  }
-
-  if (roomShape >= RoomShape.SHAPE_2x2 && !ignoreBigRoomDoubleCharge) {
-    // 2x2 rooms and L rooms should grant 2 charges.
-    return 2;
-  }
-
-  // Clearing a room grants 1 charge by default.
-  return 1;
-}
-
-/**
- * The AAA Battery should grant an extra charge when the active item is one away from being fully
- * charged.
- */
-function getNumChargesWithAAAModifier(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-  chargesToAdd: int,
-) {
-  const activeItem = player.GetActiveItem(activeSlot);
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
-  const hasAAABattery = player.HasTrinket(TrinketType.AAA_BATTERY);
-  const maxCharges = getCollectibleMaxCharges(activeItem);
-
-  if (!hasAAABattery) {
-    return chargesToAdd;
-  }
-
-  if (!hasBattery && activeCharge + chargesToAdd === maxCharges - 1) {
-    return maxCharges + 1;
-  }
-
-  if (hasBattery && batteryCharge + chargesToAdd === maxCharges - 1) {
-    return maxCharges + 1;
-  }
-
-  return chargesToAdd;
-}
-
-/**
- * Helper function to add a charge to every player's active item, emulating what happens when a room
- * is cleared.
- *
- * This function will take the following things into account:
- * - L rooms and 2x2 rooms granting a double charge
- * - The Battery
- * - AAA Battery
- *
- * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- *                                 1x1 room for the purposes of calculating how much charge to
- *                                 grant. Default is false.
- */
-export function addRoomClearCharges(ignoreBigRoomDoubleCharge = false): void {
-  for (const player of getPlayers()) {
-    addRoomClearCharge(player, ignoreBigRoomDoubleCharge);
-  }
-}
-
-/**
- * Helper function to get the combined normal charge and the battery charge for the player's active
- * item. This is useful because you have to add these two values together when setting the active
- * charge.
- */
-export function getTotalCharge(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-): int {
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-
-  return activeCharge + batteryCharge;
-}
-
-export function isActiveSlotDoubleCharged(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-): boolean {
-  const collectibleType = player.GetActiveItem(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const maxCharges = getCollectibleMaxCharges(collectibleType);
-
-  return batteryCharge >= maxCharges;
-}
-
-export function playChargeSoundEffect(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-): void {
-  for (const soundEffect of [SoundEffect.BATTERY_CHARGE, SoundEffect.BEEP]) {
-    sfxManager.Stop(soundEffect);
-  }
-
-  const chargeSoundEffect = shouldPlayFullRechargeSound(player, activeSlot)
-    ? SoundEffect.BATTERY_CHARGE
-    : SoundEffect.BEEP;
-  sfxManager.Play(chargeSoundEffect);
-}
-
-function shouldPlayFullRechargeSound(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-) {
-  const activeItem = player.GetActiveItem(activeSlot);
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
-  const maxCharges = getCollectibleMaxCharges(activeItem);
-
-  if (!hasBattery) {
-    // Play the full recharge sound if we are now fully charged.
-    return !player.NeedsCharge(activeSlot);
-  }
-
-  // Play the full recharge sound if we are now fully charged or we are exactly half-way charged.
-  return (
-    !player.NeedsCharge(activeSlot) ||
-    (activeCharge === maxCharges && batteryCharge === 0)
-  );
-}

package/functions/chargeBar.ts

@@ -1,67 +0,0 @@
-import { VectorZero } from "../constants";
-import { ChargeBarSprites } from "../interfaces/ChargeBarSprites";
-
-const CHARGE_BAR_ANM2 = "gfx/ui/ui_chargebar.anm2";
-
-/**
- * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
- * helper function.
- */
-export function newChargeBarSprites(maxCharges: int): ChargeBarSprites {
-  const back = Sprite();
-  back.Load(CHARGE_BAR_ANM2, true);
-  back.Play("BarEmpty", true);
-
-  const meter = Sprite();
-  meter.Load(CHARGE_BAR_ANM2, true);
-  meter.Play("BarFull", true);
-
-  const meterBattery = Sprite();
-  meterBattery.Load(CHARGE_BAR_ANM2, true);
-  meterBattery.Play("BarFull", true);
-
-  const lines = Sprite();
-  lines.Load(CHARGE_BAR_ANM2, true);
-  lines.Play(`BarOverlay${maxCharges}`, true);
-
-  return {
-    back,
-    meter,
-    meterBattery,
-    lines,
-    maxCharges,
-  };
-}
-
-/**
- * Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
- * function to initialize the sprites, and then call this function on every render frame.
- */
-export function renderChargeBar(
-  sprites: ChargeBarSprites,
-  position: Vector,
-  normalCharges: int,
-  batteryCharges: int,
-): void {
-  sprites.back.Render(position, VectorZero, VectorZero);
-
-  const normalChargesClamp = getChargeBarClamp(
-    normalCharges,
-    sprites.maxCharges,
-  );
-  sprites.meter.Render(position, normalChargesClamp, VectorZero);
-
-  const batteryChargesClamp = getChargeBarClamp(
-    batteryCharges,
-    sprites.maxCharges,
-  );
-  sprites.meterBattery.Render(position, batteryChargesClamp, VectorZero);
-
-  sprites.lines.Render(position, VectorZero, VectorZero);
-}
-
-function getChargeBarClamp(charges: int, maxCharges: int) {
-  const meterMultiplier = 24 / maxCharges;
-  const meterClip = 26 - charges * meterMultiplier;
-  return Vector(0, meterClip);
-}

package/functions/collectibleCacheFlag.ts

@@ -1,90 +0,0 @@
-import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
-import { getCollectibleTypeRange } from "./collectibles";
-import { getEnumValues } from "./enums";
-import { hasFlag } from "./flag";
-import { copySet, getSortedSetValues } from "./set";
-import { repeat } from "./utils";
-
-const CACHE_FLAG_TO_COLLECTIBLES_MAP = new Map<
-  CacheFlag,
-  Set<CollectibleType>
->();
-
-function initCacheFlagMap() {
-  for (const cacheFlag of getEnumValues(CacheFlag)) {
-    const collectiblesSet = new Set<CollectibleType>();
-
-    for (const collectibleType of getCollectibleTypeRange()) {
-      if (collectibleHasCacheFlag(collectibleType, cacheFlag)) {
-        collectiblesSet.add(collectibleType);
-      }
-    }
-
-    CACHE_FLAG_TO_COLLECTIBLES_MAP.set(cacheFlag, collectiblesSet);
-  }
-}
-
-export function collectibleHasCacheFlag(
-  collectibleType: CollectibleType,
-  cacheFlag: CacheFlag,
-): boolean {
-  const itemConfigItem = itemConfig.GetCollectible(collectibleType);
-  if (itemConfigItem === undefined) {
-    return false;
-  }
-
-  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
-}
-
-/**
- * Returns a set containing every collectible type with the given cache flag, including modded
- * collectibles.
- */
-export function getCollectiblesForCacheFlag(
-  cacheFlag: CacheFlag,
-): Set<CollectibleType> {
-  // Lazy initialize the map.
-  if (CACHE_FLAG_TO_COLLECTIBLES_MAP.size === 0) {
-    initCacheFlagMap();
-  }
-
-  const collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP.get(cacheFlag);
-  if (collectiblesSet === undefined) {
-    return new Set();
-  }
-
-  return copySet(collectiblesSet);
-}
-
-/**
- * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
- *
- * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
- * two Dead Doves, then this function would return:
- *
- * ```ts
- * [
- *   CollectibleType.LORD_OF_THE_PIT,
- *   CollectibleType.DEAD_DOVE,
- *   CollectibleType.DEAD_DOVE,
- * ]
- * ```
- */
-export function getPlayerCollectiblesForCacheFlag(
-  player: EntityPlayer,
-  cacheFlag: CacheFlag,
-): CollectibleType[] {
-  const collectiblesForCacheFlag = getCollectiblesForCacheFlag(cacheFlag);
-
-  const playerCollectibles: CollectibleType[] = [];
-  for (const collectibleType of getSortedSetValues(collectiblesForCacheFlag)) {
-    const numCollectibles = player.GetCollectibleNum(collectibleType);
-    repeat(numCollectibles, () => {
-      playerCollectibles.push(collectibleType);
-    });
-  }
-
-  return playerCollectibles;
-}

package/functions/collectibleSet.ts

@@ -1,56 +0,0 @@
-import { CollectibleType } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
-import { LAST_VANILLA_COLLECTIBLE_TYPE } from "../constantsFirstLast";
-import { getCollectibleTypeRange } from "./collectibles";
-
-const ALL_COLLECTIBLES_SET = new Set<CollectibleType>();
-const VANILLA_COLLECTIBLES_SET = new Set<CollectibleType>();
-const MODDED_COLLECTIBLES_SET = new Set<CollectibleType>();
-
-function initCollectibleSets() {
-  for (const collectibleType of getCollectibleTypeRange()) {
-    const itemConfigItem = itemConfig.GetCollectible(collectibleType);
-    if (itemConfigItem === undefined) {
-      continue;
-    }
-
-    ALL_COLLECTIBLES_SET.add(collectibleType);
-    if (collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE) {
-      VANILLA_COLLECTIBLES_SET.add(collectibleType);
-    } else {
-      MODDED_COLLECTIBLES_SET.add(collectibleType);
-    }
-  }
-}
-
-/**
- * Returns a set containing every valid collectible type in the game, including modded collectibles.
- */
-export function getCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the sets.
-  if (ALL_COLLECTIBLES_SET.size === 0) {
-    initCollectibleSets();
-  }
-
-  return ALL_COLLECTIBLES_SET;
-}
-
-/** Returns a set containing every modded collectible type in the game. */
-export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the sets.
-  if (ALL_COLLECTIBLES_SET.size === 0) {
-    initCollectibleSets();
-  }
-
-  return MODDED_COLLECTIBLES_SET;
-}
-
-/** Returns a set containing every valid vanilla collectible type in the game. */
-export function getVanillaCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the sets.
-  if (ALL_COLLECTIBLES_SET.size === 0) {
-    initCollectibleSets();
-  }
-
-  return VANILLA_COLLECTIBLES_SET;
-}

package/functions/collectibleTag.ts

@@ -1,89 +0,0 @@
-import { CollectibleType, ItemConfigTag } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
-import { getCollectibleTypeRange } from "./collectibles";
-import { getEnumValues } from "./enums";
-import { getFlagName } from "./flag";
-import { getPlayerCollectibleCount } from "./player";
-import { copySet } from "./set";
-
-const TAG_TO_COLLECTIBLE_TYPES_MAP = new Map<
-  ItemConfigTag,
-  Set<CollectibleType>
->();
-
-function initTagMap() {
-  // The tag to collectible types map should be valid for every tag, so we initialize it with empty
-  // sets.
-  for (const itemConfigTag of getEnumValues(ItemConfigTag)) {
-    TAG_TO_COLLECTIBLE_TYPES_MAP.set(itemConfigTag, new Set());
-  }
-
-  for (const collectibleType of getCollectibleTypeRange()) {
-    for (const itemConfigTag of getEnumValues(ItemConfigTag)) {
-      if (!collectibleHasTag(collectibleType, itemConfigTag)) {
-        continue;
-      }
-
-      const collectibleTypesSet =
-        TAG_TO_COLLECTIBLE_TYPES_MAP.get(itemConfigTag);
-      if (collectibleTypesSet === undefined) {
-        const flagName = getFlagName(itemConfigTag, ItemConfigTag);
-        error(`Failed to get the collectible types for item tag: ${flagName}`);
-      }
-      collectibleTypesSet.add(collectibleType);
-    }
-  }
-}
-
-export function collectibleHasTag(
-  collectibleType: CollectibleType,
-  tag: ItemConfigTag,
-): boolean {
-  const itemConfigItem = itemConfig.GetCollectible(collectibleType);
-  if (itemConfigItem === undefined) {
-    return false;
-  }
-
-  return itemConfigItem.HasTags(tag);
-}
-
-/**
- * Helper function to get all of the collectible types in the game that have a certain tag.
- *
- * For example, to get all of the collectible types that count as offensive for the purposes of
- * Tainted Lost:
- *
- * ```ts
- * const offensiveCollectibleTypes = getCollectibleTypesWithTag(ItemConfigTag.OFFENSIVE);
- * ```
- */
-export function getCollectibleTypesWithTag(
-  itemConfigTag: ItemConfigTag,
-): Set<CollectibleType> {
-  // Lazy initialize the map.
-  if (TAG_TO_COLLECTIBLE_TYPES_MAP.size === 0) {
-    initTagMap();
-  }
-
-  const collectibleTypes = TAG_TO_COLLECTIBLE_TYPES_MAP.get(itemConfigTag);
-  if (collectibleTypes === undefined) {
-    error(
-      `The item config tag of ${itemConfigTag} is not a valid value of the ItemConfigTag enum.`,
-    );
-  }
-
-  return copySet(collectibleTypes);
-}
-
-/** Returns the number of items that a player has towards a particular transformation. */
-export function getPlayerNumCollectiblesWithTag(
-  player: EntityPlayer,
-  itemConfigTag: ItemConfigTag,
-): int {
-  const collectibleTypesSet = getCollectibleTypesWithTag(itemConfigTag);
-  return getPlayerCollectibleCount(player, ...collectibleTypesSet.values());
-}
-
-export function isQuestCollectible(collectibleType: CollectibleType): boolean {
-  return collectibleHasTag(collectibleType, ItemConfigTag.QUEST);
-}