isaacscript-common 2.3.0 → 3.0.0

package/src/callbacks/reorderedCallbacks.ts

@@ -1,166 +0,0 @@
-/* eslint-disable sort-exports/sort-exports */
-
-// This provides the logic for:
-// - PostGameStartedReordered
-// - PostNewLevelReordered
-// - PostNewRoomReordered
-
-// By default, callbacks fire in the following order:
-// - PostNewRoom --> PostNewLevel --> PostGameStarted
-
-// It is easier to write mod code if the callbacks run in a more logical order:
-// - PostGameStarted --> PostNewLevel --> PostNewRoom
-
-// Manually reorganize the callback execution so that this is the case.
-
-import { CollectibleType, ModCallback } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import {
-  postGameStartedReorderedFire,
-  postGameStartedReorderedHasSubscriptions,
-} from "./subscriptions/postGameStartedReordered";
-import {
-  postNewLevelReorderedFire,
-  postNewLevelReorderedHasSubscriptions,
-} from "./subscriptions/postNewLevelReordered";
-import {
-  postNewRoomReorderedFire,
-  postNewRoomReorderedHasSubscriptions,
-} from "./subscriptions/postNewRoomReordered";
-
-let currentStage = null as int | null;
-let currentStageType = null as int | null;
-let usedGlowingHourGlass = false;
-let forceNewLevel = false;
-let forceNewRoom = false;
-
-/** @internal */
-export function reorderedCallbacksInit(mod: Mod): void {
-  mod.AddCallback(
-    ModCallback.POST_USE_ITEM,
-    useItemGlowingHourGlass,
-    CollectibleType.GLOWING_HOUR_GLASS,
-  ); // 3
-  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStartedVanilla); // 15
-  mod.AddCallback(ModCallback.POST_NEW_LEVEL, postNewLevelVanilla); // 18
-  mod.AddCallback(ModCallback.POST_NEW_ROOM, postNewRoomVanilla); // 19
-}
-
-function hasSubscriptions() {
-  return (
-    postGameStartedReorderedHasSubscriptions() ||
-    postNewLevelReorderedHasSubscriptions() ||
-    postNewRoomReorderedHasSubscriptions()
-  );
-}
-
-// ModCallback.POST_USE_ITEM (3)
-// CollectibleType.GLOWING_HOUR_GLASS (422)
-function useItemGlowingHourGlass() {
-  // If Glowing Hour Glass is used on the first room of a floor, it will send the player to the
-  // previous floor without triggering the PostNewLevel callback. Manually check for this.
-  usedGlowingHourGlass = true;
-}
-
-// ModCallback.POST_GAME_STARTED (15)
-function postGameStartedVanilla(isContinued: boolean) {
-  if (!hasSubscriptions()) {
-    return;
-  }
-
-  postGameStartedReorderedFire(isContinued);
-  recordCurrentStage();
-  postNewLevelReorderedFire();
-  postNewRoomReorderedFire();
-}
-
-// ModCallback.POST_NEW_LEVEL (18)
-function postNewLevelVanilla() {
-  if (!hasSubscriptions()) {
-    return;
-  }
-
-  const gameFrameCount = game.GetFrameCount();
-
-  if (gameFrameCount === 0 && !forceNewLevel) {
-    // Wait for the PostGameStarted callback to fire.
-    return;
-  }
-  forceNewLevel = false;
-
-  recordCurrentStage();
-  postNewLevelReorderedFire();
-  postNewRoomReorderedFire();
-}
-
-// ModCallback.POST_NEW_ROOM (19)
-function postNewRoomVanilla() {
-  if (!hasSubscriptions()) {
-    return;
-  }
-
-  const gameFrameCount = game.GetFrameCount();
-  const level = game.GetLevel();
-  const stage = level.GetStage();
-  const stageType = level.GetStageType();
-
-  if (usedGlowingHourGlass) {
-    usedGlowingHourGlass = false;
-
-    if (currentStage !== stage || currentStageType !== stageType) {
-      // The player has used the Glowing Hour Glass to take them to the previous floor (which does
-      // not trigger the PostNewLevel callback). Emulate what happens in the PostNewLevel callback.
-      recordCurrentStage();
-      postNewLevelReorderedFire();
-      postNewRoomReorderedFire();
-      return;
-    }
-  }
-
-  if (
-    (gameFrameCount === 0 ||
-      currentStage !== stage ||
-      currentStageType !== stageType) &&
-    !forceNewRoom
-  ) {
-    return;
-  }
-  forceNewRoom = false;
-
-  postNewRoomReorderedFire();
-}
-
-function recordCurrentStage() {
-  const level = game.GetLevel();
-  const stage = level.GetStage();
-  const stageType = level.GetStageType();
-
-  currentStage = stage;
-  currentStageType = stageType;
-}
-
-/**
- * This is a utility function for users of the `ModCallbackCustom.POST_NEW_LEVEL_REORDERED` custom
- * callback.
- *
- * If some specific cases, mods can change the current level during run initialization on the 0th
- * frame. However, due to how the callback reordering works, the custom PostNewLevel callback will
- * never fire on the 0th frame. To get around this, call this function before changing levels to
- * temporarily force the callback to fire.
- */
-export function forceNewLevelCallback(): void {
-  forceNewLevel = true;
-}
-
-/**
- * This is a utility function for users of the `ModCallbackCustom.POST_NEW_ROOM_REORDERED` custom
- * callback.
- *
- * If some specific cases, mods can change the current room during run initialization on the 0th
- * frame. However, due to how the callback reordering works, the custom PostNewRoom callback will
- * never fire on the 0th frame. To get around this, call this function before changing rooms to
- * temporarily force the callback to fire.
- */
-export function forceNewRoomCallback(): void {
-  forceNewRoom = true;
-}

package/src/callbacks/subscriptions/postBombInitLate.ts

@@ -1,32 +0,0 @@
-import { BombVariant } from "isaac-typescript-definitions";
-
-export type PostBombInitRegisterParameters = [
-  callback: (bomb: EntityBomb) => void,
-  bombVariant?: BombVariant,
-];
-
-const subscriptions: PostBombInitRegisterParameters[] = [];
-
-/** @internal */
-export function postBombInitLateHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postBombInitLateRegister(
-  ...args: PostBombInitRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postBombInitLateFire(bomb: EntityBomb): void {
-  for (const [callback, bombVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (bombVariant !== undefined && bombVariant !== bomb.Variant) {
-      continue;
-    }
-
-    callback(bomb);
-  }
-}

package/src/callbacks/subscriptions/postBoneSwing.ts

@@ -1,24 +0,0 @@
-export type PostBoneSwingRegisterParameters = [
-  callback: (boneClub: EntityKnife) => void,
-];
-
-const subscriptions: PostBoneSwingRegisterParameters[] = [];
-
-/** @internal */
-export function postBoneSwingHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postBoneSwingRegister(
-  ...args: PostBoneSwingRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postBoneSwingFire(boneClub: EntityKnife): void {
-  for (const [callback] of subscriptions) {
-    callback(boneClub);
-  }
-}

package/src/callbacks/subscriptions/postCollectibleInitFirst.ts

@@ -1,37 +0,0 @@
-import { CollectibleType } from "isaac-typescript-definitions";
-
-export type PostCollectibleInitFirstRegisterParameters = [
-  callback: (collectible: EntityPickup) => void,
-  collectibleType?: CollectibleType,
-];
-
-const subscriptions: PostCollectibleInitFirstRegisterParameters[] = [];
-
-/** @internal */
-export function postCollectibleInitFirstHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postCollectibleInitFirstRegister(
-  ...args: PostCollectibleInitFirstRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postCollectibleInitFirstFire(
-  collectible: EntityPickupCollectible,
-): void {
-  for (const [callback, collectibleType] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (
-      collectibleType !== undefined &&
-      collectibleType !== collectible.SubType
-    ) {
-      continue;
-    }
-
-    callback(collectible);
-  }
-}

package/src/callbacks/subscriptions/postCursedTeleport.ts

@@ -1,24 +0,0 @@
-export type PostCursedTeleportRegisterParameters = [
-  callback: (player: EntityPlayer) => void,
-];
-
-const subscriptions: PostCursedTeleportRegisterParameters[] = [];
-
-/** @internal */
-export function postCursedTeleportHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postCursedTeleportRegister(
-  ...args: PostCursedTeleportRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postCursedTeleportFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
-    callback(player);
-  }
-}

package/src/callbacks/subscriptions/postCustomDoorEnter.ts

@@ -1,45 +0,0 @@
-import { Direction, DoorSlot } from "isaac-typescript-definitions";
-
-export type PostCustomDoorEnterRegisterParameters = [
-  callback: (
-    player: EntityPlayer,
-    effectVariant: int,
-    doorSlot: DoorSlot,
-    direction: Direction,
-  ) => void,
-  effectVariant?: int,
-];
-
-const subscriptions: PostCustomDoorEnterRegisterParameters[] = [];
-
-/** @internal */
-export function postCustomDoorEnterHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postCustomDoorEnterRegister(
-  ...args: PostCustomDoorEnterRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postCustomDoorEnterFire(
-  player: EntityPlayer,
-  effectVariant: int,
-  doorSlot: DoorSlot,
-  direction: Direction,
-): void {
-  for (const [callback, callbackEffectVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (
-      callbackEffectVariant !== undefined &&
-      callbackEffectVariant !== effectVariant
-    ) {
-      continue;
-    }
-
-    callback(player, effectVariant, doorSlot, direction);
-  }
-}

package/src/callbacks/subscriptions/postCustomRevive.ts

@@ -1,36 +0,0 @@
-export type PostCustomReviveRegisterParameters = [
-  callback: (player: EntityPlayer, revivalType: int) => void,
-  revivalType?: int,
-];
-
-const subscriptions: PostCustomReviveRegisterParameters[] = [];
-
-/** @internal */
-export function postCustomReviveHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postCustomReviveRegister(
-  ...args: PostCustomReviveRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postCustomReviveFire(
-  player: EntityPlayer,
-  revivalType: int,
-): void {
-  for (const [callback, callbackRevivalType] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (
-      callbackRevivalType !== undefined &&
-      callbackRevivalType !== revivalType
-    ) {
-      continue;
-    }
-
-    callback(player, revivalType);
-  }
-}

package/src/callbacks/subscriptions/postDoorRender.ts

@@ -1,35 +0,0 @@
-export type PostDoorRenderRegisterParameters = [
-  callback: (door: GridEntityDoor) => void,
-  gridEntityVariant?: int,
-];
-
-const subscriptions: PostDoorRenderRegisterParameters[] = [];
-
-/** @internal */
-export function postDoorRenderHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postDoorRenderRegister(
-  ...args: PostDoorRenderRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postDoorRenderFire(door: GridEntityDoor): void {
-  const gridEntityVariant = door.GetVariant();
-
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
-      continue;
-    }
-
-    callback(door);
-  }
-}

package/src/callbacks/subscriptions/postDoorUpdate.ts

@@ -1,35 +0,0 @@
-export type PostDoorUpdateRegisterParameters = [
-  callback: (door: GridEntityDoor) => void,
-  gridEntityVariant?: int,
-];
-
-const subscriptions: PostDoorUpdateRegisterParameters[] = [];
-
-/** @internal */
-export function postDoorUpdateHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postDoorUpdateRegister(
-  ...args: PostDoorUpdateRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postDoorUpdateFire(door: GridEntityDoor): void {
-  const gridEntityVariant = door.GetVariant();
-
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
-      continue;
-    }
-
-    callback(door);
-  }
-}

package/src/callbacks/subscriptions/postEffectInitLate.ts

@@ -1,32 +0,0 @@
-import { EffectVariant } from "isaac-typescript-definitions";
-
-export type PostEffectInitLateRegisterParameters = [
-  callback: (effect: EntityEffect) => void,
-  effectVariant?: EffectVariant,
-];
-
-const subscriptions: PostEffectInitLateRegisterParameters[] = [];
-
-/** @internal */
-export function postEffectInitLateHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postEffectInitLateRegister(
-  ...args: PostEffectInitLateRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postEffectInitLateFire(effect: EntityEffect): void {
-  for (const [callback, effectVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (effectVariant !== undefined && effectVariant !== effect.Variant) {
-      continue;
-    }
-
-    callback(effect);
-  }
-}

package/src/callbacks/subscriptions/postEffectStateChanged.ts

@@ -1,40 +0,0 @@
-import { EffectVariant } from "isaac-typescript-definitions";
-
-export type PostEffectStateChangedRegisterParameters = [
-  callback: (
-    effect: EntityEffect,
-    previousState: int,
-    currentState: int,
-  ) => void,
-  effectVariant?: EffectVariant,
-];
-
-const subscriptions: PostEffectStateChangedRegisterParameters[] = [];
-
-/** @internal */
-export function postEffectStateChangedHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postEffectStateChangedRegister(
-  ...args: PostEffectStateChangedRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postEffectStateChangedFire(
-  effect: EntityEffect,
-  previousState: int,
-  currentState: int,
-): void {
-  for (const [callback, effectVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (effectVariant !== undefined && effectVariant !== effect.Variant) {
-      continue;
-    }
-
-    callback(effect, previousState, currentState);
-  }
-}

package/src/callbacks/subscriptions/postEsauJr.ts

@@ -1,24 +0,0 @@
-export type PostEsauJrRegisterParameters = [
-  callback: (player: EntityPlayer) => void,
-];
-
-const subscriptions: PostEsauJrRegisterParameters[] = [];
-
-/** @internal */
-export function postEsauJrHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postEsauJrRegister(
-  ...args: PostEsauJrRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postEsauJrFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
-    callback(player);
-  }
-}

package/src/callbacks/subscriptions/postFamiliarInitLate.ts

@@ -1,32 +0,0 @@
-import { FamiliarVariant } from "isaac-typescript-definitions";
-
-export type PostFamiliarInitLateRegisterParameters = [
-  callback: (familiar: EntityFamiliar) => void,
-  familiarVariant?: FamiliarVariant,
-];
-
-const subscriptions: PostFamiliarInitLateRegisterParameters[] = [];
-
-/** @internal */
-export function postFamiliarInitLateHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postFamiliarInitLateRegister(
-  ...args: PostFamiliarInitLateRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postFamiliarInitLateFire(familiar: EntityFamiliar): void {
-  for (const [callback, familiarVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (familiarVariant !== undefined && familiarVariant !== familiar.Variant) {
-      continue;
-    }
-
-    callback(familiar);
-  }
-}

package/src/callbacks/subscriptions/postFamiliarStateChanged.ts

@@ -1,40 +0,0 @@
-import { FamiliarVariant } from "isaac-typescript-definitions";
-
-export type PostFamiliarStateChangedRegisterParameters = [
-  callback: (
-    familiar: EntityFamiliar,
-    previousState: int,
-    currentState: int,
-  ) => void,
-  familiarVariant?: FamiliarVariant,
-];
-
-const subscriptions: PostFamiliarStateChangedRegisterParameters[] = [];
-
-/** @internal */
-export function postFamiliarStateChangedHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postFamiliarStateChangedRegister(
-  ...args: PostFamiliarStateChangedRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postFamiliarStateChangedFire(
-  familiar: EntityFamiliar,
-  previousState: int,
-  currentState: int,
-): void {
-  for (const [callback, familiarVariant] of subscriptions) {
-    // Handle the optional 2nd callback argument.
-    if (familiarVariant !== undefined && familiarVariant !== familiar.Variant) {
-      continue;
-    }
-
-    callback(familiar, previousState, currentState);
-  }
-}

package/src/callbacks/subscriptions/postFirstEsauJr.ts

@@ -1,24 +0,0 @@
-export type PostFirstEsauJrRegisterParameters = [
-  callback: (player: EntityPlayer) => void,
-];
-
-const subscriptions: PostFirstEsauJrRegisterParameters[] = [];
-
-/** @internal */
-export function postFirstEsauJrHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postFirstEsauJrRegister(
-  ...args: PostFirstEsauJrRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postFirstEsauJrFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
-    callback(player);
-  }
-}

package/src/callbacks/subscriptions/postFirstFlip.ts

@@ -1,24 +0,0 @@
-export type PostFirstFlipRegisterParameters = [
-  callback: (player: EntityPlayer) => void,
-];
-
-const subscriptions: PostFirstFlipRegisterParameters[] = [];
-
-/** @internal */
-export function postFirstFlipHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postFirstFlipRegister(
-  ...args: PostFirstFlipRegisterParameters
-): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postFirstFlipFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
-    callback(player);
-  }
-}

package/src/callbacks/subscriptions/postFlip.ts

@@ -1,22 +0,0 @@
-export type PostFlipRegisterParameters = [
-  callback: (player: EntityPlayer) => void,
-];
-
-const subscriptions: PostFlipRegisterParameters[] = [];
-
-/** @internal */
-export function postFlipHasSubscriptions(): boolean {
-  return subscriptions.length > 0;
-}
-
-/** @internal */
-export function postFlipRegister(...args: PostFlipRegisterParameters): void {
-  subscriptions.push(args);
-}
-
-/** @internal */
-export function postFlipFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
-    callback(player);
-  }
-}