isaacscript-common 26.5.0 → 26.6.0

package/dist/index.rollup.d.ts

@@ -13691,6 +13691,12 @@ export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
 
 declare class RoomHistory extends Feature {
     private postNewRoomEarly;
+    /**
+     * Helper function to manually delete the last room description from the internal array. This is
+     * useful if a mod needs to send the player to a room temporarily and the room should not count as
+     * the player having traveled to that room.
+     */
+    deleteLastRoomDescription(): void;
     /**
      * Helper function to get the total number of rooms that the player has entered thus far on the
      * run. (Re-entering the same room will increment the number returned.)
@@ -13727,7 +13733,7 @@ declare class RoomHistory extends Feature {
      */
     getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
     /** Helper function to detect if the player is on the first room of the room. */
-    isFirstRoom(): boolean;
+    inFirstRoom(): boolean;
     /**
      * Helper function to detect if the game is in the state where the room index has changed to a new
      * room, but the entities from the previous room are currently in the process of despawning. (At

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 26.5.0
+isaacscript-common 26.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -32425,6 +32425,9 @@ function RoomHistory.prototype.____constructor(self)
     end
     self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
 end
+function RoomHistory.prototype.deleteLastRoomDescription(self)
+    table.remove(v.run.roomHistory)
+end
 function RoomHistory.prototype.getNumRoomsEntered(self)
     return #v.run.roomHistory
 end
@@ -32445,7 +32448,7 @@ end
 function RoomHistory.prototype.getLatestRoomDescription(self)
     return getLastElement(nil, v.run.roomHistory)
 end
-function RoomHistory.prototype.isFirstRoom(self)
+function RoomHistory.prototype.inFirstRoom(self)
     return #v.run.roomHistory == 1
 end
 function RoomHistory.prototype.isLeavingRoom(self)
@@ -32462,11 +32465,12 @@ function RoomHistory.prototype.isLeavingRoom(self)
     end
     return startSeedString ~= latestRoomDescription.startSeedString or stage ~= latestRoomDescription.stage or stageType ~= latestRoomDescription.stageType or roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
 end
+__TS__Decorate({Exported}, RoomHistory.prototype, "deleteLastRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getNumRoomsEntered", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "isFirstRoom", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "inFirstRoom", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "isLeavingRoom", true)
 return ____exports
  end,

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

@@ -3,6 +3,12 @@ import { RoomDescription } from "../../../interfaces/RoomDescription";
 import { Feature } from "../../private/Feature";
 export declare class RoomHistory extends Feature {
     private postNewRoomEarly;
+    /**
+     * Helper function to manually delete the last room description from the internal array. This is
+     * useful if a mod needs to send the player to a room temporarily and the room should not count as
+     * the player having traveled to that room.
+     */
+    deleteLastRoomDescription(): void;
     /**
      * Helper function to get the total number of rooms that the player has entered thus far on the
      * run. (Re-entering the same room will increment the number returned.)
@@ -39,7 +45,7 @@ export declare class RoomHistory extends Feature {
      */
     getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
     /** Helper function to detect if the player is on the first room of the room. */
-    isFirstRoom(): boolean;
+    inFirstRoom(): boolean;
     /**
      * Helper function to detect if the game is in the state where the room index has changed to a new
      * room, but the entities from the previous room are currently in the process of despawning. (At

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

@@ -1 +1 @@
-{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,gBAAgB,CAgCtB;IAEF;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}
+{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,gBAAgB,CAgCtB;IAEF;;;;OAIG;IAEI,yBAAyB,IAAI,IAAI;IAIxC;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}

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

@@ -66,6 +66,9 @@ function RoomHistory.prototype.____constructor(self)
     end
     self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
 end
+function RoomHistory.prototype.deleteLastRoomDescription(self)
+    table.remove(v.run.roomHistory)
+end
 function RoomHistory.prototype.getNumRoomsEntered(self)
     return #v.run.roomHistory
 end
@@ -86,7 +89,7 @@ end
 function RoomHistory.prototype.getLatestRoomDescription(self)
     return getLastElement(nil, v.run.roomHistory)
 end
-function RoomHistory.prototype.isFirstRoom(self)
+function RoomHistory.prototype.inFirstRoom(self)
     return #v.run.roomHistory == 1
 end
 function RoomHistory.prototype.isLeavingRoom(self)
@@ -103,10 +106,11 @@ function RoomHistory.prototype.isLeavingRoom(self)
     end
     return startSeedString ~= latestRoomDescription.startSeedString or stage ~= latestRoomDescription.stage or stageType ~= latestRoomDescription.stageType or roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
 end
+__TS__Decorate({Exported}, RoomHistory.prototype, "deleteLastRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getNumRoomsEntered", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "isFirstRoom", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "inFirstRoom", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "isLeavingRoom", true)
 return ____exports

package/package.json

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

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

@@ -69,6 +69,16 @@ export class RoomHistory extends Feature {
     v.run.roomHistory.push(roomDescription);
   };
 
+  /**
+   * Helper function to manually delete the last room description from the internal array. This is
+   * useful if a mod needs to send the player to a room temporarily and the room should not count as
+   * the player having traveled to that room.
+   */
+  @Exported
+  public deleteLastRoomDescription(): void {
+    v.run.roomHistory.pop();
+  }
+
   /**
    * Helper function to get the total number of rooms that the player has entered thus far on the
    * run. (Re-entering the same room will increment the number returned.)
@@ -135,7 +145,7 @@ export class RoomHistory extends Feature {
 
   /** Helper function to detect if the player is on the first room of the room. */
   @Exported
-  public isFirstRoom(): boolean {
+  public inFirstRoom(): boolean {
     return v.run.roomHistory.length === 1;
   }