isaacscript-common 20.9.0 → 20.10.0

package/dist/index.d.ts

@@ -3310,7 +3310,7 @@ export declare function doesPlayerHaveAllSoulHearts(player: EntityPlayer): boole
  * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
  *                  0.01.
  */
-export declare function doesVectorHaveAnyLength(vector: Vector, threshold?: number): boolean;
+export declare function doesVectorHaveLength(vector: Vector, threshold?: number): boolean;
 
 export declare const DOGMA_ROOM_GRID_INDEX = 109;
 
@@ -13171,6 +13171,13 @@ export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
 
 declare class RoomHistory extends Feature {
     private postNewRoomEarly;
+    /**
+     * Helper function to get the total number of rooms that the player has visited thus far on the
+     * run.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+     */
+    getNumRoomsVisited(): ReadonlyArray<Readonly<RoomDescription>>;
     /**
      * Helper function to get information about all of the rooms that a player has visited thus far on
      * this run.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.9.0
+isaacscript-common 20.10.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17401,7 +17401,7 @@ function ____exports.deserializeVector(self, vector)
     end
     return Vector(x, y)
 end
-function ____exports.doesVectorHaveAnyLength(self, vector, threshold)
+function ____exports.doesVectorHaveLength(self, vector, threshold)
     if threshold == nil then
         threshold = 0.01
     end
@@ -19751,7 +19751,7 @@ local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local isPrimitive = ____types.isPrimitive
 local ____vector = require("src.functions.vector")
-local doesVectorHaveAnyLength = ____vector.doesVectorHaveAnyLength
+local doesVectorHaveLength = ____vector.doesVectorHaveLength
 local isVector = ____vector.isVector
 local vectorToString = ____vector.vectorToString
 function setPrimitiveEntityFields(self, entity, metatable, entityFields)
@@ -19942,7 +19942,7 @@ function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
     end
-    return doesVectorHaveAnyLength(nil, entity.Velocity, threshold)
+    return doesVectorHaveLength(nil, entity.Velocity, threshold)
 end
 function ____exports.isStoryBoss(self, entityType)
     return STORY_BOSSES_SET:has(entityType)
@@ -34187,6 +34187,9 @@ function RoomHistory.prototype.____constructor(self)
     end
     self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
 end
+function RoomHistory.prototype.getNumRoomsVisited(self)
+    return self.v.run.roomHistory
+end
 function RoomHistory.prototype.getRoomHistory(self)
     return self.v.run.roomHistory
 end
@@ -34218,6 +34221,7 @@ 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, "getNumRoomsVisited", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)

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

@@ -2,6 +2,13 @@ import { RoomDescription } from "../../../interfaces/RoomDescription";
 import { Feature } from "../../private/Feature";
 export declare class RoomHistory extends Feature {
     private postNewRoomEarly;
+    /**
+     * Helper function to get the total number of rooms that the player has visited thus far on the
+     * run.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+     */
+    getNumRoomsVisited(): ReadonlyArray<Readonly<RoomDescription>>;
     /**
      * Helper function to get information about all of the rooms that a player has visited thus far on
      * this run.

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;AAEhD,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,gBAAgB,CAgCtB;IAEF;;;;;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;;;;;;;;;;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;AAEhD,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,gBAAgB,CAgCtB;IAEF;;;;;OAKG;IAEI,kBAAkB,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIrE;;;;;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;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}

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

@@ -65,6 +65,9 @@ function RoomHistory.prototype.____constructor(self)
     end
     self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
 end
+function RoomHistory.prototype.getNumRoomsVisited(self)
+    return self.v.run.roomHistory
+end
 function RoomHistory.prototype.getRoomHistory(self)
     return self.v.run.roomHistory
 end
@@ -96,6 +99,7 @@ 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, "getNumRoomsVisited", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
 __TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)

package/dist/src/functions/entities.lua

@@ -27,7 +27,7 @@ local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local isPrimitive = ____types.isPrimitive
 local ____vector = require("src.functions.vector")
-local doesVectorHaveAnyLength = ____vector.doesVectorHaveAnyLength
+local doesVectorHaveLength = ____vector.doesVectorHaveLength
 local isVector = ____vector.isVector
 local vectorToString = ____vector.vectorToString
 function setPrimitiveEntityFields(self, entity, metatable, entityFields)
@@ -304,7 +304,7 @@ function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
     end
-    return doesVectorHaveAnyLength(nil, entity.Velocity, threshold)
+    return doesVectorHaveLength(nil, entity.Velocity, threshold)
 end
 --- Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
 -- Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only

package/dist/src/functions/vector.d.ts

@@ -22,7 +22,7 @@ export declare function deserializeVector(vector: SerializedVector): Vector;
  * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
  *                  0.01.
  */
-export declare function doesVectorHaveAnyLength(vector: Vector, threshold?: number): boolean;
+export declare function doesVectorHaveLength(vector: Vector, threshold?: number): boolean;
 /**
  * Helper function to get a random vector between (-1, -1) and (1, 1).
  *

package/dist/src/functions/vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}

package/dist/src/functions/vector.lua

@@ -61,7 +61,7 @@ end
 -- @param vector The vector to measure.
 -- @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
 -- 0.01.
-function ____exports.doesVectorHaveAnyLength(self, vector, threshold)
+function ____exports.doesVectorHaveLength(self, vector, threshold)
     if threshold == nil then
         threshold = 0.01
     end

package/package.json

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

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

@@ -67,6 +67,17 @@ export class RoomHistory extends Feature {
     this.v.run.roomHistory.push(roomDescription);
   };
 
+  /**
+   * Helper function to get the total number of rooms that the player has visited thus far on the
+   * run.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   */
+  @Exported
+  public getNumRoomsVisited(): ReadonlyArray<Readonly<RoomDescription>> {
+    return this.v.run.roomHistory;
+  }
+
   /**
    * Helper function to get information about all of the rooms that a player has visited thus far on
    * this run.

package/src/functions/entities.ts

@@ -10,7 +10,7 @@ import { getRandom } from "./random";
 import { isRNG, newRNG } from "./rng";
 import { setSpriteOpacity } from "./sprites";
 import { asNumber, isPrimitive } from "./types";
-import { doesVectorHaveAnyLength, isVector, vectorToString } from "./vector";
+import { doesVectorHaveLength, isVector, vectorToString } from "./vector";
 
 /** From DeadInfinity. */
 const DAMAGE_FLASH_COLOR: Readonly<Color> = Color(
@@ -316,7 +316,7 @@ export function hasArmor(entity: Entity): boolean {
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */
 export function isEntityMoving(entity: Entity, threshold = 0.01): boolean {
-  return doesVectorHaveAnyLength(entity.Velocity, threshold);
+  return doesVectorHaveLength(entity.Velocity, threshold);
 }
 
 /**

package/src/functions/vector.ts

@@ -71,7 +71,7 @@ export function deserializeVector(vector: SerializedVector): Vector {
  * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
  *                  0.01.
  */
-export function doesVectorHaveAnyLength(
+export function doesVectorHaveLength(
   vector: Vector,
   threshold = 0.01,
 ): boolean {