isaacscript-common 28.5.0 → 28.6.0

package/dist/index.rollup.d.ts

@@ -9103,6 +9103,19 @@ export declare function mapGetPlayer<V>(map: Map<PlayerIndex, V>, player: Entity
  */
 export declare function mapHasPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): boolean;
 
+/**
+ * All of the collectibles that grant vision on the map.
+ *
+ * Note that:
+ * - Book of Shadows is included, which is an "active mapping" instead of passive.
+ * - Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it
+ *   was buffed in Repentance to show rooms two or more away.
+ * - Luna is included, even though it is not a very powerful mapping item.
+ * - Cracked Orb is included, even though it requires the player to be damaged in order for it to be
+ *   activated.
+ */
+export declare const MAPPING_COLLECTIBLES: readonly [CollectibleType.COMPASS, CollectibleType.TREASURE_MAP, CollectibleType.BOOK_OF_SHADOWS, CollectibleType.SPELUNKER_HAT, CollectibleType.CRYSTAL_BALL, CollectibleType.BLUE_MAP, CollectibleType.MIND, CollectibleType.SOL, CollectibleType.LUNA, CollectibleType.CRACKED_ORB];
+
 /**
  * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
  * the map uses `PtrHash` as an index.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 28.5.0
+isaacscript-common 28.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17614,6 +17614,7 @@ return ____exports
 ["src.core.constants"] = function(...) 
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local Dimension = ____isaac_2Dtypescript_2Ddefinitions.Dimension
 local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
 local ItemPoolType = ____isaac_2Dtypescript_2Ddefinitions.ItemPoolType
@@ -17649,6 +17650,18 @@ ____exports.RENDER_FRAMES_PER_MINUTE = ____exports.RENDER_FRAMES_PER_SECOND * 60
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
 ____exports.LEVEL_GRID_COLUMN_HEIGHT = 13
 ____exports.LEVEL_GRID_ROW_WIDTH = 13
+____exports.MAPPING_COLLECTIBLES = {
+    CollectibleType.COMPASS,
+    CollectibleType.TREASURE_MAP,
+    CollectibleType.BOOK_OF_SHADOWS,
+    CollectibleType.SPELUNKER_HAT,
+    CollectibleType.CRYSTAL_BALL,
+    CollectibleType.BLUE_MAP,
+    CollectibleType.MIND,
+    CollectibleType.SOL,
+    CollectibleType.LUNA,
+    CollectibleType.CRACKED_ORB
+}
 ____exports.MAX_LEVEL_GRID_INDEX = 168
 ____exports.MAX_NUM_FAMILIARS = 64
 ____exports.MAX_NUM_INPUTS = 4

package/dist/src/core/constants.d.ts

@@ -1,4 +1,4 @@
-import { ItemPoolType } from "isaac-typescript-definitions";
+import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
 /**
  * The combination of the following flags:
  * - `DisplayFlag.VISIBLE` (1 << 0)
@@ -47,7 +47,7 @@ export declare const EMPTY_PNG_PATH = "gfx/none.png";
  *
  * This is equal to 4294967295.
  */
-export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: import("isaac-typescript-definitions").CollectibleType;
+export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
 /** Game frames are what is returned by the `Game.GetFrameCount` method. */
 export declare const GAME_FRAMES_PER_SECOND = 30;
 /** Game frames are what is returned by the `Game.GetFrameCount` method. */
@@ -68,6 +68,18 @@ export declare const LEVEL_GRID_COLUMN_HEIGHT = 13;
  * on.
  */
 export declare const LEVEL_GRID_ROW_WIDTH = 13;
+/**
+ * All of the collectibles that grant vision on the map.
+ *
+ * Note that:
+ * - Book of Shadows is included, which is an "active mapping" instead of passive.
+ * - Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it
+ *   was buffed in Repentance to show rooms two or more away.
+ * - Luna is included, even though it is not a very powerful mapping item.
+ * - Cracked Orb is included, even though it requires the player to be damaged in order for it to be
+ *   activated.
+ */
+export declare const MAPPING_COLLECTIBLES: readonly [CollectibleType.COMPASS, CollectibleType.TREASURE_MAP, CollectibleType.BOOK_OF_SHADOWS, CollectibleType.SPELUNKER_HAT, CollectibleType.CRYSTAL_BALL, CollectibleType.BLUE_MAP, CollectibleType.MIND, CollectibleType.SOL, CollectibleType.LUNA, CollectibleType.CRACKED_ORB];
 /**
  * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
  * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so

package/dist/src/core/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAWtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;;;GAMG;AAEH,eAAO,MAAM,+BAA+B,wDAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,QAAgC,CAAC;AAEtE,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,kBAGnD,CAAC;AAEF,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,kBAGlD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gCAAgC,kBAA8B,CAAC;AAE5E,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,mGAAmG;AACnG,eAAO,MAAM,sBAAsB,QAAmB,CAAC;AAEvD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAmB,CAAC;AAEpD,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE,4CAA4C;AAC5C,eAAO,MAAM,8BAA8B,QAA4B,CAAC;AAExE,kEAAkE;AAClE,eAAO,MAAM,gBAAgB,QAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,SAAS,kBAA0B,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,kBAA0B,CAAC;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,iBAA4B,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,aAAa,kBAAgC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAGf,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAWtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;;;GAMG;AAEH,eAAO,MAAM,+BAA+B,iBAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,QAAgC,CAAC;AAEtE,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,wRAWvB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,kBAGnD,CAAC;AAEF,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,kBAGlD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gCAAgC,kBAA8B,CAAC;AAE5E,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,mGAAmG;AACnG,eAAO,MAAM,sBAAsB,QAAmB,CAAC;AAEvD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAmB,CAAC;AAEpD,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE,4CAA4C;AAC5C,eAAO,MAAM,8BAA8B,QAA4B,CAAC;AAExE,kEAAkE;AAClE,eAAO,MAAM,gBAAgB,QAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,SAAS,kBAA0B,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,kBAA0B,CAAC;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,iBAA4B,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,aAAa,kBAAgC,CAAC"}

package/dist/src/core/constants.lua

@@ -1,5 +1,6 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local Dimension = ____isaac_2Dtypescript_2Ddefinitions.Dimension
 local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
 local ItemPoolType = ____isaac_2Dtypescript_2Ddefinitions.ItemPoolType
@@ -65,6 +66,27 @@ ____exports.LEVEL_GRID_COLUMN_HEIGHT = 13
 -- by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
 -- on.
 ____exports.LEVEL_GRID_ROW_WIDTH = 13
+--- All of the collectibles that grant vision on the map.
+-- 
+-- Note that:
+-- - Book of Shadows is included, which is an "active mapping" instead of passive.
+-- - Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it
+--   was buffed in Repentance to show rooms two or more away.
+-- - Luna is included, even though it is not a very powerful mapping item.
+-- - Cracked Orb is included, even though it requires the player to be damaged in order for it to be
+--   activated.
+____exports.MAPPING_COLLECTIBLES = {
+    CollectibleType.COMPASS,
+    CollectibleType.TREASURE_MAP,
+    CollectibleType.BOOK_OF_SHADOWS,
+    CollectibleType.SPELUNKER_HAT,
+    CollectibleType.CRYSTAL_BALL,
+    CollectibleType.BLUE_MAP,
+    CollectibleType.MIND,
+    CollectibleType.SOL,
+    CollectibleType.LUNA,
+    CollectibleType.CRACKED_ORB
+}
 --- The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
 -- by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
 -- on. The maximum room index possible is 168. (It is not 169 because we start at 0 instead of 1.)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "28.5.0",
+  "version": "28.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/core/constants.ts

@@ -1,4 +1,5 @@
 import {
+  CollectibleType,
   Dimension,
   DisplayFlag,
   ItemPoolType,
@@ -103,6 +104,30 @@ export const LEVEL_GRID_COLUMN_HEIGHT = 13;
  */
 export const LEVEL_GRID_ROW_WIDTH = 13;
 
+/**
+ * All of the collectibles that grant vision on the map.
+ *
+ * Note that:
+ * - Book of Shadows is included, which is an "active mapping" instead of passive.
+ * - Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it
+ *   was buffed in Repentance to show rooms two or more away.
+ * - Luna is included, even though it is not a very powerful mapping item.
+ * - Cracked Orb is included, even though it requires the player to be damaged in order for it to be
+ *   activated.
+ */
+export const MAPPING_COLLECTIBLES = [
+  CollectibleType.COMPASS, // 21
+  CollectibleType.TREASURE_MAP, // 54
+  CollectibleType.BOOK_OF_SHADOWS, // 58
+  CollectibleType.SPELUNKER_HAT, // 91
+  CollectibleType.CRYSTAL_BALL, // 158
+  CollectibleType.BLUE_MAP, // 246
+  CollectibleType.MIND, // 333
+  CollectibleType.SOL, // 588
+  CollectibleType.LUNA, // 589
+  CollectibleType.CRACKED_ORB, // 675
+] as const;
+
 /**
  * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
  * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so