isaacscript-common 2.1.0 → 2.3.1

package/maps/characterMap.lua

@@ -8,7 +8,7 @@ ____exports.CHARACTER_MAP = __TS__New(Map, {
     {"maggy", 1},
     {"cain", 2},
     {"judas", 3},
-    {"bluebaby", 4},
+    {"blueBaby", 4},
     {"bb", 4},
     {"eve", 5},
     {"samson", 6},
@@ -16,74 +16,74 @@ ____exports.CHARACTER_MAP = __TS__New(Map, {
     {"lazarus", 8},
     {"laz", 8},
     {"eden", 9},
-    {"thelost", 10},
+    {"theLost", 10},
     {"lost", 10},
     {"lazarus2", 11},
     {"laz2", 11},
-    {"darkjudas", 12},
-    {"djudas", 12},
-    {"blackjudas", 12},
-    {"bjudas", 12},
+    {"darkJudas", 12},
+    {"dJudas", 12},
+    {"blackJudas", 12},
+    {"bJudas", 12},
     {"lilith", 13},
     {"keeper", 14},
     {"apollyon", 15},
-    {"theforgotten", 16},
+    {"theForgotten", 16},
     {"forgotten", 16},
-    {"thesoul", 17},
+    {"theSoul", 17},
     {"soul", 17},
     {"bethany", 18},
     {"jacob", 19},
     {"esau", 20},
-    {"taintedisaac", 21},
-    {"tisaac", 21},
-    {"taintedmagdalene", 22},
-    {"tmagdalene", 22},
-    {"taintedmaggy", 22},
-    {"tmaggy", 22},
-    {"taintedcain", 23},
-    {"tcain", 23},
-    {"taintedjudas", 24},
-    {"tjudas", 24},
-    {"taintedbluebaby", 25},
-    {"tbluebaby", 25},
+    {"taintedIsaac", 21},
+    {"tIsaac", 21},
+    {"taintedMagdalene", 22},
+    {"tMagdalene", 22},
+    {"taintedMaggy", 22},
+    {"tMaggy", 22},
+    {"taintedCain", 23},
+    {"tCain", 23},
+    {"taintedJudas", 24},
+    {"tJudas", 24},
+    {"taintedBlueBaby", 25},
+    {"tBlueBaby", 25},
     {"tbb", 25},
-    {"taintedeve", 26},
-    {"teve", 26},
-    {"taintedsamson", 27},
-    {"tsamson", 27},
-    {"taintedazazel", 28},
-    {"tazazel", 28},
-    {"taintedlazarus", 29},
-    {"tlazarus", 29},
-    {"taintedlaz", 29},
-    {"tlaz", 29},
-    {"taintededen", 30},
-    {"teden", 30},
-    {"taintedlost", 31},
-    {"tlost", 31},
-    {"taintedlilith", 32},
-    {"tlilith", 32},
-    {"taintedkeeper", 33},
-    {"tkeeper", 33},
-    {"taintedapollyon", 34},
-    {"tapollyon", 34},
-    {"taintedforgotten", 34},
-    {"tforgotten", 35},
-    {"taintedbethany", 36},
-    {"tbethany", 36},
-    {"taintedjacob", 37},
-    {"tjacob", 37},
-    {"taintedlazarusdead", 38},
-    {"tlazarusdead", 38},
-    {"taintedlazdead", 38},
-    {"tlazdead", 38},
-    {"deadtaintedlazarus", 38},
-    {"deadtlazarus", 38},
-    {"deadtaintedlaz", 38},
-    {"deadtlaz", 38},
-    {"taintedjacobghost", 39},
-    {"tjacobghost", 39},
-    {"taintedsoul", 40},
-    {"tsoul", 40}
+    {"taintedEve", 26},
+    {"tEve", 26},
+    {"taintedSamson", 27},
+    {"tSamson", 27},
+    {"taintedAzazel", 28},
+    {"tAzazel", 28},
+    {"taintedLazarus", 29},
+    {"tLazarus", 29},
+    {"taintedLaz", 29},
+    {"tLaz", 29},
+    {"taintedEden", 30},
+    {"tEden", 30},
+    {"taintedLost", 31},
+    {"tLost", 31},
+    {"taintedLilith", 32},
+    {"tLilith", 32},
+    {"taintedKeeper", 33},
+    {"tKeeper", 33},
+    {"taintedApollyon", 34},
+    {"tApollyon", 34},
+    {"taintedForgotten", 34},
+    {"tForgotten", 35},
+    {"taintedBethany", 36},
+    {"tBethany", 36},
+    {"taintedJacob", 37},
+    {"tJacob", 37},
+    {"taintedLazarusDead", 38},
+    {"tLazarusDead", 38},
+    {"taintedLazDead", 38},
+    {"tLazDead", 38},
+    {"deadTaintedLazarus", 38},
+    {"deadTLazarus", 38},
+    {"deadTaintedLaz", 38},
+    {"deadTLaz", 38},
+    {"taintedJacobGhost", 39},
+    {"tJacobGhost", 39},
+    {"taintedSoul", 40},
+    {"tSoul", 40}
 })
 return ____exports

package/maps/pillEffectMap.lua

@@ -5,58 +5,58 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PillEffect = ____isaac_2Dtypescript_2Ddefinitions.PillEffect
 ____exports.PILL_EFFECT_MAP = __TS__New(Map, {
-    {"badgas", PillEffect.BAD_GAS},
+    {"badGas", PillEffect.BAD_GAS},
     {"gas", PillEffect.BAD_GAS},
-    {"badtrip", PillEffect.BAD_TRIP},
+    {"badTrip", PillEffect.BAD_TRIP},
     {"trip", PillEffect.BAD_TRIP},
-    {"ballsofsteel", PillEffect.BALLS_OF_STEEL},
-    {"ballssteel", PillEffect.BALLS_OF_STEEL},
+    {"ballsOfSteel", PillEffect.BALLS_OF_STEEL},
+    {"ballsSteel", PillEffect.BALLS_OF_STEEL},
     {"steel", PillEffect.BALLS_OF_STEEL},
-    {"bombsarekey", PillEffect.BOMBS_ARE_KEYS},
-    {"bombskey", PillEffect.BOMBS_ARE_KEYS},
+    {"bombsAreKey", PillEffect.BOMBS_ARE_KEYS},
+    {"bombsKey", PillEffect.BOMBS_ARE_KEYS},
     {"key", PillEffect.BOMBS_ARE_KEYS},
-    {"explosivediarrhea", PillEffect.EXPLOSIVE_DIARRHEA},
+    {"explosiveDiarrhea", PillEffect.EXPLOSIVE_DIARRHEA},
     {"diarrhea", PillEffect.EXPLOSIVE_DIARRHEA},
-    {"fullhealth", PillEffect.FULL_HEALTH},
-    {"healthdown", PillEffect.HEALTH_DOWN},
-    {"healthup", PillEffect.HEALTH_UP},
-    {"ifoundpills", PillEffect.I_FOUND_PILLS},
-    {"foundpills", PillEffect.I_FOUND_PILLS},
+    {"fullHealth", PillEffect.FULL_HEALTH},
+    {"healthDown", PillEffect.HEALTH_DOWN},
+    {"healthUp", PillEffect.HEALTH_UP},
+    {"iFoundPills", PillEffect.I_FOUND_PILLS},
+    {"foundPills", PillEffect.I_FOUND_PILLS},
     {"pills", PillEffect.I_FOUND_PILLS},
     {"puberty", PillEffect.PUBERTY},
-    {"prettyfly", PillEffect.PRETTY_FLY},
+    {"prettyFly", PillEffect.PRETTY_FLY},
     {"fly", PillEffect.PRETTY_FLY},
-    {"rangedown", PillEffect.RANGE_DOWN},
-    {"rangeup", PillEffect.RANGE_UP},
-    {"speeddown", PillEffect.SPEED_DOWN},
-    {"speedup", PillEffect.SPEED_UP},
-    {"tearsdown", PillEffect.TEARS_DOWN},
-    {"tearsup", PillEffect.TEARS_UP},
-    {"luckdown", PillEffect.LUCK_DOWN},
-    {"luckup", PillEffect.LUCK_UP},
+    {"rangeDown", PillEffect.RANGE_DOWN},
+    {"rangeUp", PillEffect.RANGE_UP},
+    {"speedDown", PillEffect.SPEED_DOWN},
+    {"speedUp", PillEffect.SPEED_UP},
+    {"tearsDown", PillEffect.TEARS_DOWN},
+    {"tearsUp", PillEffect.TEARS_UP},
+    {"luckDown", PillEffect.LUCK_DOWN},
+    {"luckUp", PillEffect.LUCK_UP},
     {"telepills", PillEffect.TELEPILLS},
-    {"48hourenergy", PillEffect.FORTY_EIGHT_HOUR_ENERGY},
+    {"48HourEnergy", PillEffect.FORTY_EIGHT_HOUR_ENERGY},
     {"energy", PillEffect.FORTY_EIGHT_HOUR_ENERGY},
     {"48", PillEffect.FORTY_EIGHT_HOUR_ENERGY},
     {"hematemesis", PillEffect.HEMATEMESIS},
     {"paralysis", PillEffect.PARALYSIS},
-    {"icanseeforever!", PillEffect.I_CAN_SEE_FOREVER},
-    {"cansee", PillEffect.I_CAN_SEE_FOREVER},
+    {"iCanSeeForever!", PillEffect.I_CAN_SEE_FOREVER},
+    {"canSee", PillEffect.I_CAN_SEE_FOREVER},
     {"see", PillEffect.I_CAN_SEE_FOREVER},
     {"pheromones", PillEffect.PHEROMONES},
     {"amnesia", PillEffect.AMNESIA},
-    {"lemonparty", PillEffect.LEMON_PARTY},
+    {"lemonParty", PillEffect.LEMON_PARTY},
     {"party", PillEffect.LEMON_PARTY},
-    {"ruawizard", PillEffect.R_U_A_WIZARD},
-    {"areyouawizard", PillEffect.R_U_A_WIZARD},
+    {"RUAWizard", PillEffect.R_U_A_WIZARD},
+    {"areYouAWizard", PillEffect.R_U_A_WIZARD},
     {"wizard", PillEffect.R_U_A_WIZARD},
     {"percs!", PillEffect.PERCS},
     {"addicted!", PillEffect.ADDICTED},
     {"relax", PillEffect.RELAX},
     {"???", PillEffect.QUESTION_MARKS},
-    {"onemakesyoularger", PillEffect.ONE_MAKES_YOU_LARGER},
+    {"oneMakesYouLarger", PillEffect.ONE_MAKES_YOU_LARGER},
     {"larger", PillEffect.ONE_MAKES_YOU_LARGER},
-    {"onemakesyousmaller", PillEffect.ONE_MAKES_YOU_SMALL},
+    {"oneMakesYouSmaller", PillEffect.ONE_MAKES_YOU_SMALL},
     {"smaller", PillEffect.ONE_MAKES_YOU_SMALL},
     {"infested!", PillEffect.INFESTED_EXCLAMATION},
     {"infest!", PillEffect.INFESTED_EXCLAMATION},
@@ -64,26 +64,26 @@ ____exports.PILL_EFFECT_MAP = __TS__New(Map, {
     {"infested?", PillEffect.INFESTED_QUESTION},
     {"infest?", PillEffect.INFESTED_QUESTION},
     {"inf?", PillEffect.INFESTED_QUESTION},
-    {"powerpill", PillEffect.POWER},
-    {"retrovision", PillEffect.RETRO_VISION},
+    {"powerPill", PillEffect.POWER},
+    {"retroVision", PillEffect.RETRO_VISION},
     {"vision", PillEffect.RETRO_VISION},
-    {"friendstilltheend", PillEffect.FRIENDS_TILL_THE_END},
-    {"friendsutilltheend", PillEffect.FRIENDS_TILL_THE_END},
+    {"friendsTillTheEnd", PillEffect.FRIENDS_TILL_THE_END},
+    {"friendsUntilTheEnd", PillEffect.FRIENDS_TILL_THE_END},
     {"xlax", PillEffect.X_LAX},
-    {"somethingswrong", PillEffect.SOMETHINGS_WRONG},
+    {"somethingsWrong", PillEffect.SOMETHINGS_WRONG},
     {"wrong", PillEffect.SOMETHINGS_WRONG},
-    {"imdrowsy", PillEffect.IM_DROWSY},
+    {"imDrowsy", PillEffect.IM_DROWSY},
     {"drowsy", PillEffect.IM_DROWSY},
-    {"imexcited!!!", PillEffect.IM_EXCITED},
+    {"imExcited!!!", PillEffect.IM_EXCITED},
     {"excited", PillEffect.IM_EXCITED},
     {"gulp!", PillEffect.GULP},
     {"horf!", PillEffect.HORF},
-    {"feelslikeimwalkingonsunshine!", PillEffect.FEELS_LIKE_IM_WALKING_ON_SUNSHINE},
+    {"feelsLikeImWalkingOnSunshine!", PillEffect.FEELS_LIKE_IM_WALKING_ON_SUNSHINE},
     {"walking", PillEffect.FEELS_LIKE_IM_WALKING_ON_SUNSHINE},
     {"sunshine", PillEffect.FEELS_LIKE_IM_WALKING_ON_SUNSHINE},
     {"vurp!", PillEffect.VURP},
-    {"shotspeeddown", PillEffect.SHOT_SPEED_DOWN},
-    {"shotspeedup", PillEffect.SHOT_SPEED_UP},
+    {"shotSpeedDown", PillEffect.SHOT_SPEED_DOWN},
+    {"shotSpeedUp", PillEffect.SHOT_SPEED_UP},
     {"experimental", PillEffect.EXPERIMENTAL}
 })
 return ____exports

package/maps/roomTypeMap.lua

@@ -9,12 +9,12 @@ ____exports.ROOM_TYPE_MAP = __TS__New(Map, {
     {"default", RoomType.DEFAULT},
     {"shop", RoomType.SHOP},
     {"error", RoomType.ERROR},
-    {"iamerror", RoomType.ERROR},
+    {"iAmError", RoomType.ERROR},
     {"treasure", RoomType.TREASURE},
     {"boss", RoomType.BOSS},
-    {"miniboss", RoomType.MINI_BOSS},
+    {"miniBoss", RoomType.MINI_BOSS},
     {"secret", RoomType.SECRET},
-    {"supersecret", RoomType.SUPER_SECRET},
+    {"superSecret", RoomType.SUPER_SECRET},
     {"arcade", RoomType.ARCADE},
     {"curse", RoomType.CURSE},
     {"challenge", RoomType.CHALLENGE},
@@ -23,22 +23,22 @@ ____exports.ROOM_TYPE_MAP = __TS__New(Map, {
     {"devil", RoomType.DEVIL},
     {"angel", RoomType.ANGEL},
     {"dungeon", RoomType.DUNGEON},
-    {"crawlspace", RoomType.DUNGEON},
-    {"bossrush", RoomType.BOSS_RUSH},
+    {"crawlSpace", RoomType.DUNGEON},
+    {"bossRush", RoomType.BOSS_RUSH},
     {"isaacs", RoomType.CLEAN_BEDROOM},
     {"bedroom", RoomType.CLEAN_BEDROOM},
-    {"cleanbedroom", RoomType.CLEAN_BEDROOM},
+    {"cleanBedroom", RoomType.CLEAN_BEDROOM},
+    {"dirtyBedroom", RoomType.DIRTY_BEDROOM},
     {"barren", RoomType.DIRTY_BEDROOM},
-    {"dirtybedroom", RoomType.DIRTY_BEDROOM},
     {"chest", RoomType.CHEST},
     {"dice", RoomType.DICE},
-    {"blackmarket", RoomType.BLACK_MARKET},
-    {"greedexit", RoomType.GREED_EXIT},
+    {"blackMarket", RoomType.BLACK_MARKET},
+    {"greedExit", RoomType.GREED_EXIT},
     {"planetarium", RoomType.PLANETARIUM},
     {"teleporter", RoomType.TELEPORTER},
-    {"teleporterexit", RoomType.TELEPORTER_EXIT},
-    {"secretexit", RoomType.SECRET_EXIT},
+    {"teleporterExit", RoomType.TELEPORTER_EXIT},
+    {"secretExit", RoomType.SECRET_EXIT},
     {"blue", RoomType.BLUE},
-    {"ultrasecret", RoomType.ULTRA_SECRET}
+    {"ultraSecret", RoomType.ULTRA_SECRET}
 })
 return ____exports

package/objects/LRoomShapeToRectangles.d.ts

@@ -4,7 +4,7 @@ import { RoomShape } from "isaac-typescript-definitions";
  * wall would be at "Vector(-1, -1)".)
  */
 export declare const L_ROOM_SHAPE_TO_RECTANGLES: {
-    [key in RoomShape]?: [
+    readonly [key in RoomShape]?: readonly [
         verticalTopLeft: Vector,
         verticalBottomRight: Vector,
         horizontalTopLeft: Vector,

package/objects/callbackRegisterFunctions.d.ts

@@ -1,5 +1,5 @@
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { AddCallbackParameterCustom } from "../types/AddCallbackParameterCustom";
+import { AddCallbackParameterCustom } from "../interfaces/AddCallbackParameterCustom";
 export declare const CALLBACK_REGISTER_FUNCTIONS: {
     readonly [key in ModCallbackCustom]: (...args: AddCallbackParameterCustom[key]) => void;
 };

package/objects/colors.d.ts

@@ -6,12 +6,12 @@
  * `copyColor` function.
  */
 export declare const COLORS: {
-    Black: Color;
-    Red: Color;
-    Green: Color;
-    Blue: Color;
-    Yellow: Color;
-    Pink: Color;
-    Cyan: Color;
-    White: Color;
+    readonly Black: Color;
+    readonly Red: Color;
+    readonly Green: Color;
+    readonly Blue: Color;
+    readonly Yellow: Color;
+    readonly Pink: Color;
+    readonly Cyan: Color;
+    readonly White: Color;
 };

package/objects/languageNames.d.ts

@@ -0,0 +1,4 @@
+import { LanguageAbbreviation } from "isaac-typescript-definitions";
+export declare const LANGUAGE_NAMES: {
+    readonly [key in LanguageAbbreviation]: string;
+};

package/objects/languageNames.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local LanguageAbbreviation = ____isaac_2Dtypescript_2Ddefinitions.LanguageAbbreviation
+____exports.LANGUAGE_NAMES = {
+    [LanguageAbbreviation.ENGLISH] = "English",
+    [LanguageAbbreviation.JAPANESE] = "Japanese",
+    [LanguageAbbreviation.KOREAN] = "Korean",
+    [LanguageAbbreviation.CHINESE_SIMPLE] = "Chinese (Simple)",
+    [LanguageAbbreviation.RUSSIAN] = "Russian",
+    [LanguageAbbreviation.GERMAN] = "German",
+    [LanguageAbbreviation.SPANISH] = "Spanish"
+}
+return ____exports

package/objects/roomTypeNames.lua

@@ -6,7 +6,7 @@ ____exports.ROOM_TYPE_NAMES = {
     [RoomType.NULL] = "null room",
     [RoomType.DEFAULT] = "default room",
     [RoomType.SHOP] = "shop",
-    [RoomType.ERROR] = "IAMERROR Room",
+    [RoomType.ERROR] = "I AM ERROR Room",
     [RoomType.TREASURE] = "Treasure Room",
     [RoomType.BOSS] = "Boss Room",
     [RoomType.MINI_BOSS] = "Miniboss Room",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.1.0",
+  "version": "2.3.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.53"
+    "isaac-typescript-definitions": "^2.0.54"
   }
-}
+}

package/types/PickingUpItem.d.ts

@@ -1,24 +1,34 @@
+/**
+ * This is the type that is fed to the `PRE_ITEM_PICKUP` and `POST_ITEM_PICKUP` custom callbacks.
+ *
+ * @module
+ */
 import { CollectibleType, ItemType, TrinketType } from "isaac-typescript-definitions";
 export declare type PickingUpItem = PickingUpItemNull | PickingUpItemCollectible | PickingUpItemTrinket;
+/** Part of {@link PickingUpItem}. */
 export interface PickingUpItemNull {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.NULL;
     /** Equal to either the collectible type, the trinket type, or 0. */
     subType: 0;
 }
+/** Part of {@link PickingUpItem}. */
 export interface PickingUpItemCollectible {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR;
     /** Equal to either the collectible type, the trinket type, or 0. */
     subType: CollectibleType;
 }
+/** Part of {@link PickingUpItem}. */
 export interface PickingUpItemTrinket {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.TRINKET;
     /** Equal to either the collectible type, the trinket type, or 0. */
     subType: TrinketType;
 }
-export declare function newPickingUpItem(): PickingUpItem;
-export declare function resetPickingUpItem(pickingUpItem: PickingUpItem): void;
+/** Helper function to narrow the type of `PickingUpItem`. */
+export declare function pickingUpItemIsNull(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;
+/** Helper function to narrow the type of `PickingUpItem`. */
 export declare function pickingUpItemIsCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
+/** Helper function to narrow the type of `PickingUpItem`. */
 export declare function pickingUpItemIsTrinket(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemTrinket;

package/types/PickingUpItem.lua

@@ -15,6 +15,9 @@ function ____exports.resetPickingUpItem(self, pickingUpItem)
     pickingUpItem.subType = DEFAULT_SUB_TYPE
 end
 local COLLECTIBLE_ITEM_TYPES = __TS__New(Set, {ItemType.PASSIVE, ItemType.ACTIVE, ItemType.FAMILIAR})
+function ____exports.pickingUpItemIsNull(self, pickingUpItem)
+    return pickingUpItem.itemType == ItemType.NULL
+end
 function ____exports.pickingUpItemIsCollectible(self, pickingUpItem)
     return COLLECTIBLE_ITEM_TYPES:has(pickingUpItem.itemType)
 end

package/upgradeMod.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="isaac-typescript-definitions" />
 import { ModUpgraded } from "./classes/ModUpgraded";
 /**
- * Use this function to enable the custom features and callbacks provided by `isaacscript-common`.
+ * Use this function to enable the custom callbacks and other optional features provided by
+ * `isaacscript-common`.
  *
  * For example:
  *

package/types/SaveData.d.ts

@@ -1,28 +0,0 @@
-/**
- * Each sub-object of save data has a string as a key, without arbitrary data as a value. However,
- * the data has to be serializable (i.e. no `userdata` objects).
- *
- * The values of the save data group can only be:
- * - `boolean`
- * - `number`
- * - `string`
- * - `Map` / `DefaultMap`
- * - `Set`
- * - a TSTL class
- * - serializable Isaac API classes (such as `Color`)
- * - a sub-object or `LuaTable` that contains the above values
- *
- * It is not possible to create a recursive type definition that matches these properties, so this
- * is typed as "unknown", which provides no type safety.
- */
-export declare type SaveDataGroup = Record<string, unknown>;
-/**
- * The object that contains all of the variables that will be managed by the save data manager.
- * Depending on which property is used, the variables will be reset at certain times.
- */
-export interface SaveData {
-    persistent?: SaveDataGroup;
-    run?: SaveDataGroup;
-    level?: SaveDataGroup;
-    room?: SaveDataGroup;
-}