isaacscript-common 21.2.0 → 21.3.0

package/src/functions/players.ts

@@ -6,14 +6,16 @@ import {
   NullItemID,
   PlayerForm,
   PlayerType,
-  TrinketSlot,
   TrinketType,
 } from "isaac-typescript-definitions";
+import {
+  ACTIVE_SLOT_VALUES,
+  TRINKET_SLOT_VALUES,
+} from "../arrays/cachedEnumValues";
 import { game, itemConfig } from "../core/cachedClasses";
 import { getLastElement, sumArray } from "./array";
 import { getCharacterName, isVanillaCharacter } from "./characters";
 import { getCollectibleMaxCharges } from "./collectibles";
-import { getEnumValues } from "./enums";
 import {
   getAllPlayers,
   getPlayerIndexVanilla,
@@ -119,8 +121,7 @@ export function getActiveItemSlot(
   player: EntityPlayer,
   collectibleType: CollectibleType,
 ): ActiveSlot | undefined {
-  const activeSlots = getEnumValues(ActiveSlot);
-  return activeSlots.find((activeSlot) => {
+  return ACTIVE_SLOT_VALUES.find((activeSlot) => {
     const activeItem = player.GetActiveItem(activeSlot);
     return activeItem === collectibleType;
   });
@@ -660,7 +661,7 @@ export function playerHasForm(
  * and any pocket actives.
  */
 export function removeAllActiveItems(player: EntityPlayer): void {
-  for (const activeSlot of getEnumValues(ActiveSlot)) {
+  for (const activeSlot of ACTIVE_SLOT_VALUES) {
     const collectibleType = player.GetActiveItem(activeSlot);
     if (collectibleType === CollectibleType.NULL) {
       continue;
@@ -681,7 +682,7 @@ export function removeAllActiveItems(player: EntityPlayer): void {
  * they also have smelted. (In that case, both the held and the smelted trinket will be removed.)
  */
 export function removeAllPlayerTrinkets(player: EntityPlayer): void {
-  for (const trinketSlot of getEnumValues(TrinketSlot)) {
+  for (const trinketSlot of TRINKET_SLOT_VALUES) {
     const trinketType = player.GetTrinket(trinketSlot);
     if (trinketType === TrinketType.NULL) {
       continue;

package/src/functions/pocketItems.ts

@@ -6,9 +6,9 @@ import {
   PlayerType,
   PocketItemSlot,
 } from "isaac-typescript-definitions";
+import { POCKET_ITEM_SLOT_VALUES } from "../arrays/cachedEnumValues";
 import { PocketItemType } from "../enums/PocketItemType";
 import { PocketItemDescription } from "../interfaces/PocketItemDescription";
-import { getEnumValues } from "./enums";
 import { isCharacter } from "./players";
 import { asNumber } from "./types";
 
@@ -58,12 +58,11 @@ export function getPocketItems(player: EntityPlayer): PocketItemDescription[] {
   const hasPocketItem2 = pocketItem2 !== CollectibleType.NULL;
 
   const maxPocketItems = player.GetMaxPocketItems();
-  const pocketItemSlots = getEnumValues(PocketItemSlot);
 
   const pocketItems: PocketItemDescription[] = [];
   let pocketItemIdentified = false;
   let pocketItem2Identified = false;
-  for (const slot of pocketItemSlots) {
+  for (const slot of POCKET_ITEM_SLOT_VALUES) {
     const cardType = player.GetCard(slot);
     const pillColor = player.GetPill(slot);
 

package/src/functions/roomData.ts

@@ -1,13 +1,12 @@
 import {
   DoorSlot,
-  DoorSlotFlag,
   RoomShape,
   RoomType,
   StageID,
 } from "isaac-typescript-definitions";
+import { DOOR_SLOT_FLAG_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
 import { doorSlotFlagToDoorSlot } from "./doors";
-import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";
 
 /**
@@ -22,8 +21,7 @@ export function getRoomAllowedDoors(roomGridIndex?: int): Set<DoorSlot> {
     return allowedDoors;
   }
 
-  const doorSlotFlags = getEnumValues(DoorSlotFlag);
-  for (const doorSlotFlag of doorSlotFlags) {
+  for (const doorSlotFlag of DOOR_SLOT_FLAG_VALUES) {
     if (hasFlag(roomData.Doors, doorSlotFlag)) {
       const doorSlot = doorSlotFlagToDoorSlot(doorSlotFlag);
       allowedDoors.add(doorSlot);
@@ -203,10 +201,7 @@ export function getRoomVisitedCount(roomGridIndex?: int): int {
  * Helper function to set the data for a given room. This will change the room type, contents, and
  * so on.
  */
-export function setRoomData(
-  roomGridIndex: int,
-  roomData: Readonly<RoomConfig>,
-): void {
+export function setRoomData(roomGridIndex: int, roomData: RoomConfig): void {
   const roomDescriptor = getRoomDescriptor(roomGridIndex);
   roomDescriptor.Data = roomData;
 }

package/src/functions/roomShapeWalls.ts

@@ -1,8 +1,8 @@
 import { BossID, RoomShape } from "isaac-typescript-definitions";
+import { ROOM_SHAPE_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
 import { CornerType } from "../enums/CornerType";
 import { Corner } from "../interfaces/Corner";
-import { getEnumValues } from "./enums";
 import { getGridIndexesBetween } from "./gridIndex";
 import { inBossRoomOf, inHomeCloset } from "./rooms";
 import { getRoomShapeCorners, isLRoom } from "./roomShape";
@@ -13,7 +13,7 @@ const ROOM_SHAPE_TO_WALL_GRID_INDEX_SET: ReadonlyMap<
 > = (() => {
   const roomShapeToWallGridIndexSet = new Map<RoomShape, ReadonlySet<int>>();
 
-  for (const roomShape of getEnumValues(RoomShape)) {
+  for (const roomShape of ROOM_SHAPE_VALUES) {
     const gridIndexSet = getVanillaWallGridIndexSetForRoomShape(roomShape);
     roomShapeToWallGridIndexSet.set(roomShape, gridIndexSet);
   }

package/src/functions/serialization.ts

@@ -1,5 +1,5 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SERIALIZATION_BRAND_VALUES } from "../arrays/cachedEnumValues";
 import { ISAAC_API_CLASS_TYPE_TO_BRAND } from "../objects/isaacAPIClassTypeToBrand";
 import {
   CopyableIsaacAPIClass,
@@ -10,12 +10,12 @@ import {
   SerializedIsaacAPIClass,
 } from "../objects/isaacAPIClassTypeToFunctions";
 import { ReadonlySet } from "../types/ReadonlySet";
-import { getEnumValues } from "./enums";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
 import { isString, isTable, isUserdata } from "./types";
 
-const SERIALIZATION_BRANDS = getEnumValues(SerializationBrand);
-const SERIALIZATION_BRAND_SET = new ReadonlySet<string>(SERIALIZATION_BRANDS);
+const SERIALIZATION_BRAND_SET = new ReadonlySet<string>(
+  SERIALIZATION_BRAND_VALUES,
+);
 
 /**
  * Helper function to generically copy an Isaac API class without knowing what specific type of

package/src/functions/sound.ts

@@ -4,6 +4,7 @@ import {
   SoundEffect,
   StageType,
 } from "isaac-typescript-definitions";
+import { SOUND_EFFECT_VALUES } from "../arrays/cachedEnumValues";
 import { game, sfxManager } from "../core/cachedClasses";
 import { STAGE_TO_MUSIC } from "../objects/stageToMusic";
 import { getEnumValues } from "./enums";
@@ -42,7 +43,7 @@ export function getMusicForStage(
  *                          your mod.
  */
 export function stopAllSoundEffects(soundEffectCustom?: unknown): void {
-  for (const soundEffect of getEnumValues(SoundEffect)) {
+  for (const soundEffect of SOUND_EFFECT_VALUES) {
     sfxManager.Stop(soundEffect);
   }
 

package/src/functions/transformations.ts

@@ -3,11 +3,11 @@ import {
   ItemConfigTag,
   PlayerForm,
 } from "isaac-typescript-definitions";
+import { PLAYER_FORM_VALUES } from "../arrays/cachedEnumValues";
 import { TRANSFORMATION_NAMES } from "../objects/transformationNames";
 import { ReadonlyMap } from "../types/ReadonlyMap";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { getCollectibleTags } from "./collectibles";
-import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";
 
 const TRANSFORMATION_TO_TAG_MAP = new ReadonlyMap<PlayerForm, ItemConfigTag>([
@@ -39,7 +39,7 @@ export function getPlayerTransformations(
   player: EntityPlayer,
 ): Set<PlayerForm> {
   const transformations = new Set<PlayerForm>();
-  for (const playerForm of getEnumValues(PlayerForm)) {
+  for (const playerForm of PLAYER_FORM_VALUES) {
     if (player.HasPlayerForm(playerForm)) {
       transformations.add(playerForm);
     }
@@ -71,9 +71,8 @@ export function getTransformationsForCollectibleType(
 ): Set<PlayerForm> {
   const itemConfigTags = getCollectibleTags(collectibleType);
 
-  const playerForms = getEnumValues(PlayerForm);
   const transformationSet = new Set<PlayerForm>();
-  for (const playerForm of playerForms) {
+  for (const playerForm of PLAYER_FORM_VALUES) {
     const itemConfigTag = TRANSFORMATION_TO_TAG_MAP.get(playerForm);
     if (itemConfigTag === undefined) {
       continue;

package/src/index.ts

@@ -134,6 +134,7 @@ export * from "./interfaces/RoomDescription";
 export * from "./interfaces/SaveData";
 export * from "./interfaces/StatTypeType";
 export * from "./interfaces/TrinketSituation";
+export * from "./interfaces/TSTLClassMetatable";
 export * from "./maps/cardNameToTypeMap";
 export * from "./maps/characterNameToTypeMap";
 export * from "./maps/pillNameToEffectMap";

package/src/interfaces/CustomStageTSConfig.ts

@@ -568,13 +568,7 @@ export interface CustomStageBossPoolEntry {
   };
 }
 
-/**
- * An object that represents a custom stage. The "customStageMetadata.lua" file contains an array of
- * these objects. Besides the room metadata, the data is the same as what is specified inside the
- * "tsconfig.json" file.
- *
- * The `CustomStage` interface extends this, adding more data.
- */
+/** An intermediate type that is never actually used. See `CustomStageLua`. */
 interface CustomStageLuaUnsafe extends CustomStageTSConfig {
   /**
    * This contains metadata about each room in a custom stage, which is used at run-time.
@@ -584,6 +578,13 @@ interface CustomStageLuaUnsafe extends CustomStageTSConfig {
   roomsMetadata: CustomStageRoomMetadata[];
 }
 
+/**
+ * An object that represents a custom stage. The "customStageMetadata.lua" file contains an array of
+ * these objects. Besides the room metadata, the data is the same as what is specified inside the
+ * "tsconfig.json" file.
+ *
+ * The `CustomStage` interface extends this, adding more data.
+ */
 export type CustomStageLua = Immutable<CustomStageLuaUnsafe>;
 
 /**

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -13,6 +13,7 @@ import {
   GridEntityXMLType,
   InputHook,
   ItemType,
+  Keyboard,
   KnifeVariant,
   LaserVariant,
   PickupVariant,
@@ -366,6 +367,11 @@ export interface AddCallbackParametersCustom {
         trinketType?: TrinketType,
       ];
 
+  [ModCallbackCustom.POST_KEYBOARD_PRESSED]: [
+    callback: (keyboard: Keyboard) => void,
+    keyboard?: Keyboard,
+  ];
+
   [ModCallbackCustom.POST_KNIFE_INIT_LATE]: [
     callback: (knife: EntityKnife) => void,
     knifeVariant?: KnifeVariant,

package/src/patchErrorFunctions.ts

@@ -46,19 +46,11 @@ export function patchErrorFunction(): void {
   error = errorWithTraceback;
 }
 
-function errorWithTraceback(
-  this: void,
-  message: string,
-  level?: number,
-): never {
+function errorWithTraceback(this: void, message: string, level = 1): never {
   if (vanillaError === undefined) {
     error(message, level);
   }
 
-  if (level === undefined) {
-    level = 1;
-  }
-
   const tracebackOutput = getTraceback();
   const slimmedTracebackOutput = slimTracebackOutput(tracebackOutput);
   message += "\n";