isaacscript-common 28.7.0 → 29.0.0

package/dist/index.rollup.d.ts

@@ -9127,14 +9127,14 @@ export declare function mapHasPlayer<V>(map: Map<PlayerIndex, V>, player: Entity
  * 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.
+ * - Book of Secrets is included, which is an "active mapping" instead of passive.
  * - 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];
+export declare const MAPPING_COLLECTIBLES: readonly [CollectibleType.COMPASS, CollectibleType.TREASURE_MAP, CollectibleType.SPELUNKER_HAT, CollectibleType.CRYSTAL_BALL, CollectibleType.BLUE_MAP, CollectibleType.BOOK_OF_SECRETS, 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
@@ -13028,10 +13028,13 @@ declare class PersistentEntities extends Feature {
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.PERSISTENT_ENTITIES`.
      *
-     * @returns A tuple containing the entity and the persistent entity index. You can use the index
+     * @returns An object containing the entity and the persistent entity index. You can use the index
      *          with the `removePersistentEntity` function.
      */
-    spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): [Entity, int];
+    spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): {
+        entity: Entity;
+        persistentIndex: int;
+    };
 }
 
 export declare type PickingUpItem = PickingUpItemNull | PickingUpItemCollectible | PickingUpItemTrinket;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 28.7.0
+isaacscript-common 29.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17661,10 +17661,10 @@ ____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.BOOK_OF_SECRETS,
     CollectibleType.MIND,
     CollectibleType.SOL,
     CollectibleType.LUNA,
@@ -50415,7 +50415,7 @@ function PersistentEntities.prototype.spawnPersistentEntity(self, entityType, va
         position,
         v.run.persistentEntityIndexCounter
     )
-    return {entity, v.run.persistentEntityIndexCounter}
+    return {entity = entity, persistentIndex = v.run.persistentEntityIndexCounter}
 end
 __TS__Decorate({Exported}, PersistentEntities.prototype, "removePersistentEntity", true)
 __TS__Decorate({Exported}, PersistentEntities.prototype, "spawnPersistentEntity", true)

package/dist/src/classes/features/other/PersistentEntities.d.ts

@@ -38,9 +38,12 @@ export declare class PersistentEntities extends Feature {
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.PERSISTENT_ENTITIES`.
      *
-     * @returns A tuple containing the entity and the persistent entity index. You can use the index
+     * @returns An object containing the entity and the persistent entity index. You can use the index
      *          with the `removePersistentEntity` function.
      */
-    spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): [Entity, int];
+    spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): {
+        entity: Entity;
+        persistentIndex: int;
+    };
 }
 //# sourceMappingURL=PersistentEntities.d.ts.map

package/dist/src/classes/features/other/PersistentEntities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PersistentEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PersistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAmChD,qBAAa,kBAAmB,SAAQ,OAAO;IAI7C,OAAO,CAAC,WAAW,CAAc;IAqBjC,OAAO,CAAC,gBAAgB,CAgBtB;IAEF;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,oBAAoB,CAkB1B;IAEF,OAAO,CAAC,aAAa;IAsBrB;;;;;;;;;;;OAWG;IAEI,sBAAsB,CAC3B,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI;IAiBP;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf,CAAC,MAAM,EAAE,GAAG,CAAC;CAajB"}
+{"version":3,"file":"PersistentEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PersistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAmChD,qBAAa,kBAAmB,SAAQ,OAAO;IAI7C,OAAO,CAAC,WAAW,CAAc;IAqBjC,OAAO,CAAC,gBAAgB,CAgBtB;IAEF;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,oBAAoB,CAkB1B;IAEF,OAAO,CAAC,aAAa;IAsBrB;;;;;;;;;;;OAWG;IAEI,sBAAsB,CAC3B,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI;IAiBP;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,GAAG,CAAA;KAAE;CAa5C"}

package/dist/src/classes/features/other/PersistentEntities.lua

@@ -147,7 +147,7 @@ function PersistentEntities.prototype.spawnPersistentEntity(self, entityType, va
         position,
         v.run.persistentEntityIndexCounter
     )
-    return {entity, v.run.persistentEntityIndexCounter}
+    return {entity = entity, persistentIndex = v.run.persistentEntityIndexCounter}
 end
 __TS__Decorate({Exported}, PersistentEntities.prototype, "removePersistentEntity", true)
 __TS__Decorate({Exported}, PersistentEntities.prototype, "spawnPersistentEntity", true)

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

@@ -72,14 +72,14 @@ 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.
+ * - Book of Secrets is included, which is an "active mapping" instead of passive.
  * - 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];
+export declare const MAPPING_COLLECTIBLES: readonly [CollectibleType.COMPASS, CollectibleType.TREASURE_MAP, CollectibleType.SPELUNKER_HAT, CollectibleType.CRYSTAL_BALL, CollectibleType.BLUE_MAP, CollectibleType.BOOK_OF_SECRETS, 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.lua

@@ -69,19 +69,19 @@ ____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.
+-- - Book of Secrets is included, which is an "active mapping" instead of passive.
 -- - 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.BOOK_OF_SECRETS,
     CollectibleType.MIND,
     CollectibleType.SOL,
     CollectibleType.LUNA,

package/package.json

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

package/src/classes/features/other/PersistentEntities.ts

@@ -201,7 +201,7 @@ export class PersistentEntities extends Feature {
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.PERSISTENT_ENTITIES`.
    *
-   * @returns A tuple containing the entity and the persistent entity index. You can use the index
+   * @returns An object containing the entity and the persistent entity index. You can use the index
    *          with the `removePersistentEntity` function.
    */
   @Exported
@@ -210,7 +210,7 @@ export class PersistentEntities extends Feature {
     variant: int,
     subType: int,
     position: Vector,
-  ): [Entity, int] {
+  ): { entity: Entity; persistentIndex: int } {
     v.run.persistentEntityIndexCounter++;
 
     const entity = this.spawnAndTrack(
@@ -221,6 +221,6 @@ export class PersistentEntities extends Feature {
       v.run.persistentEntityIndexCounter,
     );
 
-    return [entity, v.run.persistentEntityIndexCounter];
+    return { entity, persistentIndex: v.run.persistentEntityIndexCounter };
   }
 }

package/src/core/constants.ts

@@ -108,9 +108,9 @@ 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.
+ * - Book of Secrets is included, which is an "active mapping" instead of passive.
  * - 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.
@@ -118,10 +118,10 @@ export const LEVEL_GRID_ROW_WIDTH = 13;
 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.BOOK_OF_SECRETS, // 287
   CollectibleType.MIND, // 333
   CollectibleType.SOL, // 588
   CollectibleType.LUNA, // 589