isaacscript-common 13.3.4 → 14.1.0

package/src/callbacks/subscriptions/postGridEntityUpdate.ts

@@ -3,7 +3,7 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export type PostGridEntityUpdateRegisterParameters = [
   callback: (gridEntity: GridEntity) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityUpdateRegisterParameters[] = [];
@@ -20,12 +20,12 @@ export function postGridEntityUpdateRegister(
 
 export function postGridEntityUpdateFire(gridEntity: GridEntity): void {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
 
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -36,10 +36,7 @@ export function postGridEntityUpdateFire(gridEntity: GridEntity): void {
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postHolyMantleRemoved.ts

@@ -29,9 +29,16 @@ export function postHolyMantleRemovedFire(
 ): void {
   const character = player.GetPlayerType();
 
-  for (const [callback, callbackVariant, callbackCharacter] of subscriptions) {
+  for (const [
+    callback,
+    callbackPlayerVariant,
+    callbackCharacter,
+  ] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (callbackVariant !== undefined && callbackVariant !== player.Variant) {
+    if (
+      callbackPlayerVariant !== undefined &&
+      callbackPlayerVariant !== player.Variant
+    ) {
       continue;
     }
 

package/src/callbacks/subscriptions/postPEffectUpdateReordered.ts

@@ -21,9 +21,16 @@ export function postPEffectUpdateReorderedRegister(
 export function postPEffectUpdateReorderedFire(player: EntityPlayer): void {
   const character = player.GetPlayerType();
 
-  for (const [callback, callbackVariant, callbackCharacter] of subscriptions) {
+  for (const [
+    callback,
+    callbackPlayerVariant,
+    callbackCharacter,
+  ] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (callbackVariant !== undefined && callbackVariant !== player.Variant) {
+    if (
+      callbackPlayerVariant !== undefined &&
+      callbackPlayerVariant !== player.Variant
+    ) {
       continue;
     }
 

package/src/callbacks/subscriptions/postRockRender.ts

@@ -1,6 +1,8 @@
 export type PostRockRenderRegisterParameters = [
   callback: (rock: GridEntityRock) => void,
-  gridEntityVariant?: int,
+  // This is not `RockVariant` because `GridEntityRock` can be other grid entity types than just
+  // `GridEntityType.ROCK`.
+  variant?: int,
 ];
 
 const subscriptions: PostRockRenderRegisterParameters[] = [];
@@ -16,14 +18,11 @@ export function postRockRenderRegister(
 }
 
 export function postRockRenderFire(rock: GridEntityRock): void {
-  const gridEntityVariant = rock.GetVariant();
+  const variant = rock.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postRockUpdate.ts

@@ -1,6 +1,8 @@
 export type PostRockUpdateRegisterParameters = [
   callback: (rock: GridEntityRock) => void,
-  gridEntityVariant?: int,
+  // This is not `RockVariant` because `GridEntityRock` can be other grid entity types than just
+  // `GridEntityType.ROCK`.
+  variant?: int,
 ];
 
 const subscriptions: PostRockUpdateRegisterParameters[] = [];
@@ -16,14 +18,11 @@ export function postRockUpdateRegister(
 }
 
 export function postRockUpdateFire(rock: GridEntityRock): void {
-  const gridEntityVariant = rock.GetVariant();
+  const variant = rock.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postSpikesRender.ts

@@ -1,6 +1,6 @@
 export type PostSpikesRenderRegisterParameters = [
   callback: (spikes: GridEntitySpikes) => void,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostSpikesRenderRegisterParameters[] = [];
@@ -16,14 +16,11 @@ export function postSpikesRenderRegister(
 }
 
 export function postSpikesRenderFire(spikes: GridEntitySpikes): void {
-  const gridEntityVariant = spikes.GetVariant();
+  const variant = spikes.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postSpikesUpdate.ts

@@ -1,6 +1,6 @@
 export type PostSpikesUpdateRegisterParameters = [
   callback: (spikes: GridEntitySpikes) => void,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostSpikesUpdateRegisterParameters[] = [];
@@ -16,14 +16,11 @@ export function postSpikesUpdateRegister(
 }
 
 export function postSpikesUpdateFire(spikes: GridEntitySpikes): void {
-  const gridEntityVariant = spikes.GetVariant();
+  const variant = spikes.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postTNTRender.ts

@@ -1,6 +1,6 @@
 export type PostTNTRenderRegisterParameters = [
   callback: (tnt: GridEntityTNT) => void,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostTNTRenderRegisterParameters[] = [];
@@ -16,14 +16,11 @@ export function postTNTRenderRegister(
 }
 
 export function postTNTRenderFire(tnt: GridEntityTNT): void {
-  const gridEntityVariant = tnt.GetVariant();
+  const variant = tnt.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postTNTUpdate.ts

@@ -1,6 +1,6 @@
 export type PostTNTUpdateRegisterParameters = [
   callback: (tnt: GridEntityTNT) => void,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostTNTUpdateRegisterParameters[] = [];
@@ -16,14 +16,11 @@ export function postTNTUpdateRegister(
 }
 
 export function postTNTUpdateFire(tnt: GridEntityTNT): void {
-  const gridEntityVariant = tnt.GetVariant();
+  const variant = tnt.GetVariant();
 
-  for (const [callback, callbackGridEntityVariant] of subscriptions) {
+  for (const [callback, callbackVariant] of subscriptions) {
     // Handle the optional 2nd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks.ts

@@ -0,0 +1,134 @@
+import { PostAmbushFinished } from "./classes/callbacks/PostAmbushFinished";
+import { PostAmbushStarted } from "./classes/callbacks/PostAmbushStarted";
+import { PostBombExploded } from "./classes/callbacks/PostBombExploded";
+import { PostBombInitLate } from "./classes/callbacks/PostBombInitLate";
+import { PostBoneSwing } from "./classes/callbacks/PostBoneSwing";
+import { PostCollectibleEmpty } from "./classes/callbacks/PostCollectibleEmpty";
+import { PostCollectibleInitFirst } from "./classes/callbacks/PostCollectibleInitFirst";
+import { PostCursedTeleport } from "./classes/callbacks/PostCursedTeleport";
+import { PostCustomRevive } from "./classes/callbacks/PostCustomRevive";
+import { PostDiceRoomActivated } from "./classes/callbacks/PostDiceRoomActivated";
+import { PostDoorRender } from "./classes/callbacks/PostDoorRender";
+import { PostDoorUpdate } from "./classes/callbacks/PostDoorUpdate";
+import { PostEffectInitLate } from "./classes/callbacks/PostEffectInitLate";
+import { PostEffectStateChanged } from "./classes/callbacks/PostEffectStateChanged";
+import { PostEsauJr } from "./classes/callbacks/PostEsauJr";
+import { PostFamiliarInitLate } from "./classes/callbacks/PostFamiliarInitLate";
+import { PostFamiliarStateChanged } from "./classes/callbacks/PostFamiliarStateChanged";
+import { PostFirstEsauJr } from "./classes/callbacks/PostFirstEsauJr";
+import { PostFirstFlip } from "./classes/callbacks/PostFirstFlip";
+import { PostFlip } from "./classes/callbacks/PostFlip";
+import { PostGameStartedReordered } from "./classes/callbacks/PostGameStartedReordered";
+import { PostGameStartedReorderedLast } from "./classes/callbacks/PostGameStartedReorderedLast";
+import { PostGreedModeWave } from "./classes/callbacks/PostGreedModeWave";
+import { PostGridEntityBroken } from "./classes/callbacks/PostGridEntityBroken";
+import { PostGridEntityCollision } from "./classes/callbacks/PostGridEntityCollision";
+import { PostGridEntityCustomBroken } from "./classes/callbacks/PostGridEntityCustomBroken";
+import { PostGridEntityCustomCollision } from "./classes/callbacks/PostGridEntityCustomCollision";
+import { PostGridEntityCustomInit } from "./classes/callbacks/PostGridEntityCustomInit";
+import { PostGridEntityCustomRemove } from "./classes/callbacks/PostGridEntityCustomRemove";
+import { PostGridEntityCustomStateChanged } from "./classes/callbacks/PostGridEntityCustomStateChanged";
+import { PostGridEntityCustomUpdate } from "./classes/callbacks/PostGridEntityCustomUpdate";
+import { PostGridEntityInit } from "./classes/callbacks/PostGridEntityInit";
+import { PostGridEntityRemove } from "./classes/callbacks/PostGridEntityRemove";
+import { PostGridEntityStateChanged } from "./classes/callbacks/PostGridEntityStateChanged";
+import { PostGridEntityUpdate } from "./classes/callbacks/PostGridEntityUpdate";
+import { PostHolyMantleRemoved } from "./classes/callbacks/PostHolyMantleRemoved";
+import { PostKnifeInitLate } from "./classes/callbacks/PostKnifeInitLate";
+import { PostNewLevelReordered } from "./classes/callbacks/PostNewLevelReordered";
+import { PostNewRoomEarly } from "./classes/callbacks/PostNewRoomEarly";
+import { PostNewRoomReordered } from "./classes/callbacks/PostNewRoomReordered";
+import { PostPEffectUpdateReordered } from "./classes/callbacks/PostPEffectUpdateReordered";
+import { PostPitRender } from "./classes/callbacks/PostPitRender";
+import { PostPlayerFatalDamage } from "./classes/callbacks/PostPlayerFatalDamage";
+import { PostPlayerRenderReordered } from "./classes/callbacks/PostPlayerRenderReordered";
+import { PostPlayerUpdateReordered } from "./classes/callbacks/PostPlayerUpdateReordered";
+import { PostRoomClearChanged } from "./classes/callbacks/PostRoomClearChanged";
+import { PostSpikesRender } from "./classes/callbacks/PostSpikesRender";
+import { PreBerserkDeath } from "./classes/callbacks/PreBerserkDeath";
+import { PreCustomRevive } from "./classes/callbacks/PreCustomRevive";
+import { ModCallbackCustom2 } from "./enums/ModCallbackCustom2";
+import { newObjectWithEnumKeys } from "./functions/utils";
+
+const MOD_CALLBACK_CUSTOM_TO_CLASS = newObjectWithEnumKeys(ModCallbackCustom2, {
+  [ModCallbackCustom2.POST_AMBUSH_FINISHED]: PostAmbushFinished,
+  [ModCallbackCustom2.POST_AMBUSH_STARTED]: PostAmbushStarted,
+  [ModCallbackCustom2.POST_BOMB_EXPLODED]: PostBombExploded,
+  [ModCallbackCustom2.POST_BOMB_INIT_LATE]: PostBombInitLate,
+  [ModCallbackCustom2.POST_BONE_SWING]: PostBoneSwing,
+  [ModCallbackCustom2.POST_COLLECTIBLE_EMPTY]: PostCollectibleEmpty,
+  [ModCallbackCustom2.POST_COLLECTIBLE_INIT_FIRST]: PostCollectibleInitFirst,
+  [ModCallbackCustom2.POST_CURSED_TELEPORT]: PostCursedTeleport,
+  [ModCallbackCustom2.POST_CUSTOM_REVIVE]: PostCustomRevive,
+  [ModCallbackCustom2.POST_DICE_ROOM_ACTIVATED]: PostDiceRoomActivated,
+  [ModCallbackCustom2.POST_DOOR_RENDER]: PostDoorRender,
+  [ModCallbackCustom2.POST_DOOR_UPDATE]: PostDoorUpdate,
+  [ModCallbackCustom2.POST_EFFECT_INIT_LATE]: PostEffectInitLate,
+  [ModCallbackCustom2.POST_EFFECT_STATE_CHANGED]: PostEffectStateChanged,
+  [ModCallbackCustom2.POST_ESAU_JR]: PostEsauJr,
+  [ModCallbackCustom2.POST_FAMILIAR_INIT_LATE]: PostFamiliarInitLate,
+  [ModCallbackCustom2.POST_FAMILIAR_STATE_CHANGED]: PostFamiliarStateChanged,
+  [ModCallbackCustom2.POST_FIRST_FLIP]: PostFirstFlip,
+  [ModCallbackCustom2.POST_FIRST_ESAU_JR]: PostFirstEsauJr,
+  [ModCallbackCustom2.POST_FLIP]: PostFlip,
+  [ModCallbackCustom2.POST_GAME_STARTED_REORDERED]: PostGameStartedReordered,
+  [ModCallbackCustom2.POST_GAME_STARTED_REORDERED_LAST]:
+    PostGameStartedReorderedLast,
+  [ModCallbackCustom2.POST_GREED_MODE_WAVE]: PostGreedModeWave,
+  [ModCallbackCustom2.POST_GRID_ENTITY_BROKEN]: PostGridEntityBroken,
+  [ModCallbackCustom2.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollision,
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_BROKEN]:
+    PostGridEntityCustomBroken,
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_COLLISION]:
+    PostGridEntityCustomCollision,
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_INIT]: PostGridEntityCustomInit,
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_REMOVE]:
+    PostGridEntityCustomRemove,
+  // [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_RENDER]: new PostGridEntityCustomRender(),
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_STATE_CHANGED]:
+    PostGridEntityCustomStateChanged,
+  [ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_UPDATE]:
+    PostGridEntityCustomUpdate,
+  [ModCallbackCustom2.POST_GRID_ENTITY_INIT]: PostGridEntityInit,
+  [ModCallbackCustom2.POST_GRID_ENTITY_REMOVE]: PostGridEntityRemove,
+  // [ModCallbackCustom2.POST_GRID_ENTITY_RENDER]: new PostGridEntityRender(),
+  [ModCallbackCustom2.POST_GRID_ENTITY_STATE_CHANGED]:
+    PostGridEntityStateChanged,
+  [ModCallbackCustom2.POST_GRID_ENTITY_UPDATE]: PostGridEntityUpdate,
+  [ModCallbackCustom2.POST_HOLY_MANTLE_REMOVED]: PostHolyMantleRemoved,
+
+  // ----------------
+
+  [ModCallbackCustom2.POST_KNIFE_INIT_LATE]: PostKnifeInitLate,
+  [ModCallbackCustom2.POST_NEW_LEVEL_REORDERED]: PostNewLevelReordered,
+  [ModCallbackCustom2.POST_NEW_ROOM_EARLY]: PostNewRoomEarly,
+  [ModCallbackCustom2.POST_NEW_ROOM_REORDERED]: PostNewRoomReordered,
+  [ModCallbackCustom2.POST_PEFFECT_UPDATE_REORDERED]:
+    PostPEffectUpdateReordered,
+  [ModCallbackCustom2.POST_PIT_RENDER]: PostPitRender,
+  [ModCallbackCustom2.POST_PLAYER_FATAL_DAMAGE]: PostPlayerFatalDamage,
+  [ModCallbackCustom2.POST_PLAYER_RENDER_REORDERED]: PostPlayerRenderReordered,
+  [ModCallbackCustom2.POST_PLAYER_UPDATE_REORDERED]: PostPlayerUpdateReordered,
+  [ModCallbackCustom2.POST_ROOM_CLEAR_CHANGED]: PostRoomClearChanged,
+  [ModCallbackCustom2.POST_SPIKES_RENDER]: PostSpikesRender,
+  [ModCallbackCustom2.PRE_BERSERK_DEATH]: PreBerserkDeath,
+  [ModCallbackCustom2.PRE_CUSTOM_REVIVE]: PreCustomRevive,
+} as const);
+
+export type ModCallbackCustomToClass = {
+  [Property in keyof typeof MOD_CALLBACK_CUSTOM_TO_CLASS]: InstanceType<
+    typeof MOD_CALLBACK_CUSTOM_TO_CLASS[Property]
+  >;
+};
+
+export function getCallbacks(): ModCallbackCustomToClass {
+  const entries = Object.entries(MOD_CALLBACK_CUSTOM_TO_CLASS);
+  const instantiatedClasses = entries.map(
+    ([modCallbackCustom, constructor]) => [
+      modCallbackCustom,
+      new constructor(),
+    ],
+  );
+
+  return instantiatedClasses as unknown as ModCallbackCustomToClass;
+}

package/src/classes/DefaultMap.ts

@@ -119,7 +119,7 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
    * If the key exists, this will return the same thing as the normal `Map.get` method. Otherwise,
    * it will set a default value for the provided key, and then return the default value.
    */
-  getAndSetDefault(key: Key, ...args: Args): Value {
+  public getAndSetDefault(key: Key, ...args: Args): Value {
     const value = super.get(key);
     if (value !== undefined) {
       return value;
@@ -134,7 +134,7 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
    * Returns the default value to be used for a new key. (If a factory function was provided during
    * instantiation, this will execute the factory function.)
    */
-  getDefaultValue(...args: Args): Value {
+  public getDefaultValue(...args: Args): Value {
     if (this.defaultValue !== undefined) {
       return this.defaultValue;
     }
@@ -150,7 +150,7 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
    * Helper method for cloning the map. Returns either the default value or a reference to the
    * factory function.
    */
-  getConstructorArg(): Value | FactoryFunction<Value, Args> {
+  public getConstructorArg(): Value | FactoryFunction<Value, Args> {
     if (this.defaultValue !== undefined) {
       return this.defaultValue;
     }

package/src/classes/ModFeature.ts

@@ -0,0 +1,14 @@
+import { ModUpgraded } from "./ModUpgraded";
+
+/**
+ * A helper class for a mod that wants to represent its individual features as classes. This is
+ * useful if you are using decorators to represent class methods that should be automatically
+ * subscribed to callbacks.
+ */
+export class ModFeature {
+  private mod: ModUpgraded;
+
+  constructor(mod: ModUpgraded) {
+    this.mod = mod;
+  }
+}