isaacscript-common 61.0.0 → 62.0.0

package/dist/src/objects/trinketNames.lua

@@ -0,0 +1,199 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+____exports.DEFAULT_TRINKET_NAME = "Unknown"
+--- Maps trinket types to the real English names from the "stringtable.sta" file.
+-- 
+-- For a mapping of name to `TrinketType`, see `TRINKET_NAME_TO_TYPE_MAP`.
+____exports.TRINKET_NAMES = {
+    [TrinketType.NULL] = ____exports.DEFAULT_TRINKET_NAME,
+    [TrinketType.SWALLOWED_PENNY] = "Swallowed Penny",
+    [TrinketType.PETRIFIED_POOP] = "Petrified Poop",
+    [TrinketType.AAA_BATTERY] = "AAA Battery",
+    [TrinketType.BROKEN_REMOTE] = "Broken Remote",
+    [TrinketType.PURPLE_HEART] = "Purple Heart",
+    [TrinketType.BROKEN_MAGNET] = "Broken Magnet",
+    [TrinketType.ROSARY_BEAD] = "Rosary Bead",
+    [TrinketType.CARTRIDGE] = "Cartridge",
+    [TrinketType.PULSE_WORM] = "Pulse Worm",
+    [TrinketType.WIGGLE_WORM] = "Wiggle Worm",
+    [TrinketType.RING_WORM] = "Ring Worm",
+    [TrinketType.FLAT_WORM] = "Flat Worm",
+    [TrinketType.STORE_CREDIT] = "Store Credit",
+    [TrinketType.CALLUS] = "Callus",
+    [TrinketType.LUCKY_ROCK] = "Lucky Rock",
+    [TrinketType.MOMS_TOENAIL] = "Mom's Toenail",
+    [TrinketType.BLACK_LIPSTICK] = "Black Lipstick",
+    [TrinketType.BIBLE_TRACT] = "Bible Tract",
+    [TrinketType.PAPER_CLIP] = "Paper Clip",
+    [TrinketType.MONKEY_PAW] = "Monkey Paw",
+    [TrinketType.MYSTERIOUS_PAPER] = "Mysterious Paper",
+    [TrinketType.DAEMONS_TAIL] = "Daemon's Tail",
+    [TrinketType.MISSING_POSTER] = "Missing Poster",
+    [TrinketType.BUTT_PENNY] = "Butt Penny",
+    [TrinketType.MYSTERIOUS_CANDY] = "Mysterious Candy",
+    [TrinketType.HOOK_WORM] = "Hook Worm",
+    [TrinketType.WHIP_WORM] = "Whip Worm",
+    [TrinketType.BROKEN_ANKH] = "Broken Ankh",
+    [TrinketType.FISH_HEAD] = "Fish Head",
+    [TrinketType.PINKY_EYE] = "Pinky Eye",
+    [TrinketType.PUSH_PIN] = "Push Pin",
+    [TrinketType.LIBERTY_CAP] = "Liberty Cap",
+    [TrinketType.UMBILICAL_CORD] = "Umbilical Cord",
+    [TrinketType.CHILDS_HEART] = "Child's Heart",
+    [TrinketType.CURVED_HORN] = "Curved Horn",
+    [TrinketType.RUSTED_KEY] = "Rusted Key",
+    [TrinketType.GOAT_HOOF] = "Goat Hoof",
+    [TrinketType.MOMS_PEARL] = "Mom's Pearl",
+    [TrinketType.CANCER] = "Cancer",
+    [TrinketType.RED_PATCH] = "Red Patch",
+    [TrinketType.MATCH_STICK] = "Match Stick",
+    [TrinketType.LUCKY_TOE] = "Lucky Toe",
+    [TrinketType.CURSED_SKULL] = "Cursed Skull",
+    [TrinketType.SAFETY_CAP] = "Safety Cap",
+    [TrinketType.ACE_OF_SPADES] = "Ace of Spades",
+    [TrinketType.ISAACS_FORK] = "Isaac's Fork",
+    [TrinketType.MISSING_PAGE] = "A Missing Page",
+    [TrinketType.BLOODY_PENNY] = "Bloody Penny",
+    [TrinketType.BURNT_PENNY] = "Burnt Penny",
+    [TrinketType.FLAT_PENNY] = "Flat Penny",
+    [TrinketType.COUNTERFEIT_PENNY] = "Counterfeit Penny",
+    [TrinketType.TICK] = "Tick",
+    [TrinketType.ISAACS_HEAD] = "Isaac's Head",
+    [TrinketType.MAGGYS_FAITH] = "Maggy's Faith",
+    [TrinketType.JUDAS_TONGUE] = "Judas' Tongue",
+    [TrinketType.BLUE_BABYS_SOUL] = "???'s Soul",
+    [TrinketType.SAMSONS_LOCK] = "Samson's Lock",
+    [TrinketType.CAINS_EYE] = "Cain's Eye",
+    [TrinketType.EVES_BIRD_FOOT] = "Eve's Bird Foot",
+    [TrinketType.LEFT_HAND] = "The Left Hand",
+    [TrinketType.SHINY_ROCK] = "Shiny Rock",
+    [TrinketType.SAFETY_SCISSORS] = "Safety Scissors",
+    [TrinketType.RAINBOW_WORM] = "Rainbow Worm",
+    [TrinketType.TAPE_WORM] = "Tape Worm",
+    [TrinketType.LAZY_WORM] = "Lazy Worm",
+    [TrinketType.CRACKED_DICE] = "Cracked Dice",
+    [TrinketType.SUPER_MAGNET] = "Super Magnet",
+    [TrinketType.FADED_POLAROID] = "Faded Polaroid",
+    [TrinketType.LOUSE] = "Louse",
+    [TrinketType.BOBS_BLADDER] = "Bob's Bladder",
+    [TrinketType.WATCH_BATTERY] = "Watch Battery",
+    [TrinketType.BLASTING_CAP] = "Blasting Cap",
+    [TrinketType.STUD_FINDER] = "Stud Finder",
+    [TrinketType.ERROR] = "Error",
+    [TrinketType.POKER_CHIP] = "Poker Chip",
+    [TrinketType.BLISTER] = "Blister",
+    [TrinketType.SECOND_HAND] = "Second Hand",
+    [TrinketType.ENDLESS_NAMELESS] = "Endless Nameless",
+    [TrinketType.BLACK_FEATHER] = "Black Feather",
+    [TrinketType.BLIND_RAGE] = "Blind Rage",
+    [TrinketType.GOLDEN_HORSE_SHOE] = "Golden Horse Shoe",
+    [TrinketType.STORE_KEY] = "Store Key",
+    [TrinketType.RIB_OF_GREED] = "Rib of Greed",
+    [TrinketType.KARMA] = "Karma",
+    [TrinketType.LIL_LARVA] = "Lil Larva",
+    [TrinketType.MOMS_LOCKET] = "Mom's Locket",
+    [TrinketType.NO] = "NO!",
+    [TrinketType.CHILD_LEASH] = "Child Leash",
+    [TrinketType.BROWN_CAP] = "Brown Cap",
+    [TrinketType.MECONIUM] = "Meconium",
+    [TrinketType.CRACKED_CROWN] = "Cracked Crown",
+    [TrinketType.USED_DIAPER] = "Used Diaper",
+    [TrinketType.FISH_TAIL] = "Fish Tail",
+    [TrinketType.BLACK_TOOTH] = "Black Tooth",
+    [TrinketType.OUROBOROS_WORM] = "Ouroboros Worm",
+    [TrinketType.TONSIL] = "Tonsil",
+    [TrinketType.NOSE_GOBLIN] = "Nose Goblin",
+    [TrinketType.SUPER_BALL] = "Super Ball",
+    [TrinketType.VIBRANT_BULB] = "Vibrant Bulb",
+    [TrinketType.DIM_BULB] = "Dim Bulb",
+    [TrinketType.FRAGMENTED_CARD] = "Fragmented Card",
+    [TrinketType.EQUALITY] = "Equality!",
+    [TrinketType.WISH_BONE] = "Wish Bone",
+    [TrinketType.BAG_LUNCH] = "Bag Lunch",
+    [TrinketType.LOST_CORK] = "Lost Cork",
+    [TrinketType.CROW_HEART] = "Crow Heart",
+    [TrinketType.WALNUT] = "Walnut",
+    [TrinketType.DUCT_TAPE] = "Duct Tape",
+    [TrinketType.SILVER_DOLLAR] = "Silver Dollar",
+    [TrinketType.BLOODY_CROWN] = "Bloody Crown",
+    [TrinketType.PAY_TO_WIN] = "Pay To Win",
+    [TrinketType.LOCUST_OF_WRATH] = "Locust of War",
+    [TrinketType.LOCUST_OF_PESTILENCE] = "Locust of Pestilence",
+    [TrinketType.LOCUST_OF_FAMINE] = "Locust of Famine",
+    [TrinketType.LOCUST_OF_DEATH] = "Locust of Death",
+    [TrinketType.LOCUST_OF_CONQUEST] = "Locust of Conquest",
+    [TrinketType.BAT_WING] = "Bat Wing",
+    [TrinketType.STEM_CELL] = "Stem Cell",
+    [TrinketType.HAIRPIN] = "Hairpin",
+    [TrinketType.WOODEN_CROSS] = "Wooden Cross",
+    [TrinketType.BUTTER] = "Butter!",
+    [TrinketType.FILIGREE_FEATHERS] = "Filigree Feather",
+    [TrinketType.DOOR_STOP] = "Door Stop",
+    [TrinketType.EXTENSION_CORD] = "Extension Cord",
+    [TrinketType.ROTTEN_PENNY] = "Rotten Penny",
+    [TrinketType.BABY_BENDER] = "Baby-Bender",
+    [TrinketType.FINGER_BONE] = "Finger Bone",
+    [TrinketType.JAW_BREAKER] = "Jawbreaker",
+    [TrinketType.CHEWED_PEN] = "Chewed Pen",
+    [TrinketType.BLESSED_PENNY] = "Blessed Penny",
+    [TrinketType.BROKEN_SYRINGE] = "Broken Syringe",
+    [TrinketType.SHORT_FUSE] = "Short Fuse",
+    [TrinketType.GIGANTE_BEAN] = "Gigante Bean",
+    [TrinketType.LIGHTER] = "A Lighter",
+    [TrinketType.BROKEN_PADLOCK] = "Broken Padlock",
+    [TrinketType.MYOSOTIS] = "Myosotis",
+    [TrinketType.M] = " 'M",
+    [TrinketType.TEARDROP_CHARM] = "Teardrop Charm",
+    [TrinketType.APPLE_OF_SODOM] = "Apple of Sodom",
+    [TrinketType.FORGOTTEN_LULLABY] = "Forgotten Lullaby",
+    [TrinketType.BETHS_FAITH] = "Beth's Faith",
+    [TrinketType.OLD_CAPACITOR] = "Old Capacitor",
+    [TrinketType.BRAIN_WORM] = "Brain Worm",
+    [TrinketType.PERFECTION] = "Perfection",
+    [TrinketType.DEVILS_CROWN] = "Devil's Crown",
+    [TrinketType.CHARGED_PENNY] = "Charged Penny",
+    [TrinketType.FRIENDSHIP_NECKLACE] = "Friendship Necklace",
+    [TrinketType.PANIC_BUTTON] = "Panic Button",
+    [TrinketType.BLUE_KEY] = "Blue Key",
+    [TrinketType.FLAT_FILE] = "Flat File",
+    [TrinketType.TELESCOPE_LENS] = "Telescope Lens",
+    [TrinketType.MOMS_LOCK] = "Mom's Lock",
+    [TrinketType.DICE_BAG] = "Dice Bag",
+    [TrinketType.HOLY_CROWN] = "Holy Crown",
+    [TrinketType.MOTHERS_KISS] = "Mother's Kiss",
+    [TrinketType.TORN_CARD] = "Torn Card",
+    [TrinketType.TORN_POCKET] = "Torn Pocket",
+    [TrinketType.GILDED_KEY] = "Gilded Key",
+    [TrinketType.LUCKY_SACK] = "Lucky Sack",
+    [TrinketType.WICKED_CROWN] = "Wicked Crown",
+    [TrinketType.AZAZELS_STUMP] = "Azazel's Stump",
+    [TrinketType.DINGLE_BERRY] = "Dingle Berry",
+    [TrinketType.RING_CAP] = "Ring Cap",
+    [TrinketType.NUH_UH] = "Nuh Uh!",
+    [TrinketType.MODELING_CLAY] = "Modeling Clay",
+    [TrinketType.POLISHED_BONE] = "Polished Bone",
+    [TrinketType.HOLLOW_HEART] = "Hollow Heart",
+    [TrinketType.KIDS_DRAWING] = "Kid's Drawing",
+    [TrinketType.CRYSTAL_KEY] = "Crystal Key",
+    [TrinketType.KEEPERS_BARGAIN] = "Keeper's Bargain",
+    [TrinketType.CURSED_PENNY] = "Cursed Penny",
+    [TrinketType.YOUR_SOUL] = "Your Soul",
+    [TrinketType.NUMBER_MAGNET] = "Number Magnet",
+    [TrinketType.STRANGE_KEY] = "Strange Key",
+    [TrinketType.LIL_CLOT] = "Lil Clot",
+    [TrinketType.TEMPORARY_TATTOO] = "Temporary Tattoo",
+    [TrinketType.SWALLOWED_M80] = "Swallowed M80",
+    [TrinketType.RC_REMOTE] = "RC Remote",
+    [TrinketType.FOUND_SOUL] = "Found Soul",
+    [TrinketType.EXPANSION_PACK] = "Expansion Pack",
+    [TrinketType.BETHS_ESSENCE] = "Beth's Essence",
+    [TrinketType.TWINS] = "The Twins",
+    [TrinketType.ADOPTION_PAPERS] = "Adoption Papers",
+    [TrinketType.CRICKET_LEG] = "Cricket Leg",
+    [TrinketType.APOLLYONS_BEST_FRIEND] = "Apollyon's Best Friend",
+    [TrinketType.BROKEN_GLASSES] = "Broken Glasses",
+    [TrinketType.ICE_CUBE] = "Ice Cube",
+    [TrinketType.SIGIL_OF_BAPHOMET] = "Sigil of Baphomet"
+}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "61.0.0",
+  "version": "62.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -25,6 +25,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^27.0.0"
+    "isaac-typescript-definitions": "^28.0.0"
   }
 }

package/src/functions/collectibles.ts

@@ -23,13 +23,13 @@ import {
 import { LAST_VANILLA_COLLECTIBLE_TYPE } from "../core/constantsFirstLast";
 import { VANILLA_COLLECTIBLE_TYPES } from "../core/constantsVanilla";
 import {
-  COLLECTIBLE_DESCRIPTION_MAP,
+  COLLECTIBLE_DESCRIPTIONS,
   DEFAULT_COLLECTIBLE_DESCRIPTION,
-} from "../maps/collectibleDescriptionMap";
+} from "../objects/collectibleDescriptions";
 import {
-  COLLECTIBLE_TYPE_TO_NAME_MAP,
+  COLLECTIBLE_NAMES,
   DEFAULT_COLLECTIBLE_NAME,
-} from "../maps/collectibleTypeToNameMap";
+} from "../objects/collectibleNames";
 import { SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET } from "../sets/singleUseActiveCollectibleTypesSet";
 import { getEntityID } from "./entities";
 import { hasFlag } from "./flag";
@@ -170,8 +170,9 @@ export function getCollectibleDescription(
 
   // "ItemConfigItem.Description" is bugged with vanilla items on patch v1.7.6, so we use a
   // hard-coded map as a workaround.
-  const collectibleDescription =
-    COLLECTIBLE_DESCRIPTION_MAP.get(collectibleType);
+  const collectibleDescription = COLLECTIBLE_DESCRIPTIONS[collectibleType] as
+    | string
+    | undefined;
   if (collectibleDescription !== undefined) {
     return collectibleDescription;
   }
@@ -354,7 +355,9 @@ export function getCollectibleName(
 
   // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
   // as a workaround.
-  const collectibleName = COLLECTIBLE_TYPE_TO_NAME_MAP.get(collectibleType);
+  const collectibleName = COLLECTIBLE_NAMES[collectibleType] as
+    | string
+    | undefined;
   if (collectibleName !== undefined) {
     return collectibleName;
   }

package/src/functions/frames.ts

@@ -240,7 +240,7 @@ export function onOrBeforeRoomFrame(
   const room = game.GetRoom();
 
   const thisGameFrameCount = room.GetFrameCount();
-  return thisGameFrameCount >= roomFrameCount;
+  return thisGameFrameCount <= roomFrameCount;
 }
 
 /**
@@ -257,7 +257,7 @@ export function onRenderFrame(
   }
 
   const thisRenderFrameCount = Isaac.GetFrameCount();
-  return thisRenderFrameCount >= renderFrameCount;
+  return thisRenderFrameCount === renderFrameCount;
 }
 
 /**

package/src/functions/trinkets.ts

@@ -6,12 +6,9 @@ import { LAST_VANILLA_TRINKET_TYPE } from "../core/constantsFirstLast";
 import { MysteriousPaperEffect } from "../enums/MysteriousPaperEffect";
 import {
   DEFAULT_TRINKET_DESCRIPTION,
-  TRINKET_DESCRIPTION_MAP,
-} from "../maps/trinketDescriptionMap";
-import {
-  DEFAULT_TRINKET_NAME,
-  TRINKET_TYPE_TO_NAME_MAP,
-} from "../maps/trinketTypeToNameMap";
+  TRINKET_DESCRIPTIONS,
+} from "../objects/trinketDescriptions";
+import { DEFAULT_TRINKET_NAME, TRINKET_NAMES } from "../objects/trinketNames";
 import { getEntityID } from "./entities";
 import { getEnumLength } from "./enums";
 import { hasFlag } from "./flag";
@@ -103,8 +100,10 @@ export function getNormalTrinketType(trinketType: TrinketType): TrinketType {
  */
 export function getTrinketDescription(trinketType: TrinketType): string {
   // "ItemConfigItem.Description" is bugged with vanilla items on patch v1.7.6, so we use a
-  // hard-coded map as a workaround.
-  const trinketDescription = TRINKET_DESCRIPTION_MAP.get(trinketType);
+  // hard-coded object as a workaround.
+  const trinketDescription = TRINKET_DESCRIPTIONS[trinketType] as
+    | string
+    | undefined;
   if (trinketDescription !== undefined) {
     return trinketDescription;
   }
@@ -143,9 +142,9 @@ export function getTrinketGfxFilename(trinketType: TrinketType): string {
  * For example, `getTrinketName(TrinketType.SWALLOWED_PENNY)` would return "Swallowed Penny".
  */
 export function getTrinketName(trinketType: TrinketType): string {
-  // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
-  // as a workaround.
-  const trinketName = TRINKET_TYPE_TO_NAME_MAP.get(trinketType);
+  // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded
+  // object as a workaround.
+  const trinketName = TRINKET_NAMES[trinketType] as string | undefined;
   if (trinketName !== undefined) {
     return trinketName;
   }

package/src/maps/collectibleNameToTypeMap.ts

@@ -1,17 +1,26 @@
+import type { CollectibleType } from "isaac-typescript-definitions";
 import { removeNonAlphanumericCharacters } from "../functions/string";
-import { ReadonlyMap } from "../types/ReadonlyMap";
-import { COLLECTIBLE_TYPE_TO_NAME_MAP } from "./collectibleTypeToNameMap";
+import { COLLECTIBLE_NAMES } from "../objects/collectibleNames";
+import type { ReadonlyMap } from "../types/ReadonlyMap";
 
 /**
  * Maps collectible names to the values of the `CollectibleType` enum.
  *
- * For a mapping of `CollectibleType` to name, see `COLLECTIBLE_TYPE_TO_NAME_MAP`.
+ * For a mapping of `CollectibleType` to name, see the `COLLECTIBLE_NAMES` constant.
  */
-export const COLLECTIBLE_NAME_TO_TYPE_MAP = new ReadonlyMap(
-  [...COLLECTIBLE_TYPE_TO_NAME_MAP.entries()].map(
-    ([collectibleType, collectibleName]) => [
-      removeNonAlphanumericCharacters(collectibleName),
-      collectibleType,
-    ],
-  ),
-);
+export const COLLECTIBLE_NAME_TO_TYPE_MAP: ReadonlyMap<
+  string,
+  CollectibleType
+> = (() => {
+  const collectibleNameToTypeMap = new Map<string, CollectibleType>();
+
+  for (const [collectibleTypeString, name] of Object.entries(
+    COLLECTIBLE_NAMES,
+  )) {
+    const collectibleType = collectibleTypeString as unknown as CollectibleType;
+    const simpleString = removeNonAlphanumericCharacters(name);
+    collectibleNameToTypeMap.set(simpleString, collectibleType);
+  }
+
+  return collectibleNameToTypeMap;
+})();

package/src/maps/trinketNameToTypeMap.ts

@@ -1,17 +1,18 @@
 import type { TrinketType } from "isaac-typescript-definitions";
 import { removeNonAlphanumericCharacters } from "../functions/string";
-import { TRINKET_TYPE_TO_NAME_MAP } from "./trinketTypeToNameMap";
+import { TRINKET_NAMES } from "../objects/trinketNames";
 
 /**
  * Maps trinket names to the values of the `TrinketType` enum.
  *
- * For a mapping of `TrinketType` to name, see `TRINKET_TYPE_TO_NAME_MAP`.
+ * For a mapping of `TrinketType` to name, see the `TRINKET_NAMES` constant.
  */
 export const TRINKET_NAME_TO_TYPE_MAP: ReadonlyMap<string, TrinketType> =
   (() => {
     const trinketNameToTypeMap = new Map<string, TrinketType>();
 
-    for (const [trinketType, name] of TRINKET_TYPE_TO_NAME_MAP) {
+    for (const [trinketTypeString, name] of Object.entries(TRINKET_NAMES)) {
+      const trinketType = trinketTypeString as unknown as TrinketType;
       const simpleString = removeNonAlphanumericCharacters(name);
       trinketNameToTypeMap.set(simpleString, trinketType);
     }