isaacscript-common 2.0.9 → 2.0.12

package/dist/functions/rooms.d.ts

@@ -41,8 +41,9 @@ export declare function getRoomTypeName(roomType: RoomType): string;
  * the list.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- * extra-dimensional rooms are automatically be generated and can be seen when you iterate over the
- * `RoomList`. Default is false.
+ *                                     extra-dimensional rooms are automatically be generated and
+ *                                     can be seen when you iterate over the `RoomList`. Default is
+ *                                     false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
@@ -113,8 +114,8 @@ export declare function inStartingRoom(): boolean;
  * This function will only check rooms in the current dimension.
  *
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
- * the array will be ignored. If not specified, then all rooms will be checked. Undefined by
- * default.
+ *                           the array will be ignored. If not specified, then all rooms will be
+ *                           checked. Undefined by default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
 export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;

package/dist/functions/rooms.lua

@@ -39,8 +39,6 @@ local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____math = require("functions.math")
-local erange = ____math.erange
 local ____positionVelocity = require("functions.positionVelocity")
 local getEntityPositions = ____positionVelocity.getEntityPositions
 local getEntityVelocities = ____positionVelocity.getEntityVelocities
@@ -58,6 +56,8 @@ local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
 local ____roomShape = require("functions.roomShape")
 local getGridIndexDelta = ____roomShape.getGridIndexDelta
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
         includeExtraDimensionalRooms = false

package/dist/functions/set.d.ts

@@ -26,7 +26,7 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  *
  * @param set The set to get an element from.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;

package/dist/functions/spawnCollectible.d.ts

@@ -8,11 +8,11 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * @param collectibleType The collectible type to spawn.
  * @param position The position to spawn the collectible at.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param options Optional. Set to true to make the collectible a "There's Options" style
- * collectible. Default is false.
+ *                collectible. Default is false.
  * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
- * Tainted Keeper. Default is false.
+ *                      Tainted Keeper. Default is false.
  */
 export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean): EntityPickup;
 /**
@@ -25,6 +25,6 @@ export declare function spawnCollectible(collectibleType: CollectibleType | int,
  *
  * @param position The position to spawn the empty collectible at.
  * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
 export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;

package/dist/functions/sprite.lua

@@ -4,8 +4,8 @@ local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 local VectorZero = ____constants.VectorZero
 local ____kColor = require("functions.kColor")
 local kColorEquals = ____kColor.kColorEquals
-local ____math = require("functions.math")
-local erange = ____math.erange
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
     local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
     local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)

package/dist/functions/transformations.d.ts

@@ -17,7 +17,8 @@ export declare function getPlayerTransformations(player: EntityPlayer): Set<Play
 /**
  * Helper function to get a transformation name from a PlayerForm enum.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const transformationName = getTransformationName(PlayerForm.LORD_OF_THE_FLIES);
  * // transformationName is "Beelzebub"

package/dist/functions/trinketCacheFlag.lua

@@ -11,12 +11,12 @@ local ____constantsMax = require("constantsMax")
 local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
 local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 function initCacheFlagMap(self)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local trinketsSet = __TS__New(Set)

package/dist/functions/trinketGive.d.ts

@@ -14,7 +14,7 @@ export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation:
  * @param player The player to smelt the trinkets to.
  * @param trinketType The trinket type to smelt.
  * @param numTrinkets Optional. If specified, will smelt the given number of trinkets. Use this to
- * avoid calling this function multiple times. Default is 1.
+ *                    avoid calling this function multiple times. Default is 1.
  */
 export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType | int, numTrinkets?: number): void;
 /**

package/dist/functions/trinketSet.lua

@@ -6,10 +6,10 @@ local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsMax = require("constantsMax")
 local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local TRINKET_SET = __TS__New(Set)
 local function initTrinketSet(self)
     for ____, trinketType in ipairs(irange(nil, 1, MAX_TRINKET_TYPE)) do

package/dist/functions/trinkets.d.ts

@@ -9,7 +9,8 @@ export declare function getGoldenTrinketType(trinketType: TrinketType | int): Tr
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * const trinketSlot = getOpenTrinketSlotNum(player);
@@ -29,7 +30,8 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const trinketType = TrinketType.SWALLOWED_PENNY;
  * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
@@ -53,8 +55,9 @@ export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean
  *
  * @param trinket The trinket whose sprite you want to modify.
  * @param pngPath Equal to either the spritesheet path to load (e.g.
- * "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If undefined, the sprite
- * will be removed, making it appear like the collectible has already been taken by the player.
+ *                "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If
+ *                undefined, the sprite will be removed, making it appear like the collectible has
+ *                already been taken by the player.
  */
 export declare function setTrinketSprite(trinket: EntityPickup, pngPath: string | undefined): void;
 export declare function trinketHasCacheFlag(trinketType: TrinketType | int, cacheFlag: CacheFlag): boolean;

package/dist/functions/ui.d.ts

@@ -6,8 +6,8 @@
  * offset setting so that mods can render UI elements to the screen in the correct position.
  *
  * @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
- * then this function will return `Vector.Zero.` Otherwise, it will return a Vector that represents
- * a HUD offset that should be added to the position of a UI element.
+ *          then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+ *          represents a HUD offset that should be added to the position of a UI element.
  */
 export declare function getHUDOffsetVector(): Vector;
 /**

package/dist/functions/utils.d.ts

@@ -4,7 +4,8 @@
  *
  * Very useful to be future-safe against people adding values to a type or an enum.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * enum Situation {
  *   ONE,
@@ -35,6 +36,15 @@
  * ```
  */
 export declare const ensureAllCases: (obj: never) => never;
+/**
+ * Helper function to return an array with the elements from start to end. It is inclusive at the
+ * start and exclusive at the end. (The "e" stands for exclusive.)
+ *
+ * For example, `erange(1, 3)` will return `[1, 2]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function erange(start: int, end?: int): int[];
 /**
  * Helper function to log what is happening in functions that recursively move through nested data
  * structures.
@@ -46,6 +56,15 @@ export declare function getTraversalDescription(key: unknown, traversalDescripti
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  */
 export declare function hexToKColor(hexString: string, alpha: float): KColor;
+/**
+ * Helper function to return an array with the elements from start to end, inclusive. (The "i"
+ * stands for inclusive.)
+ *
+ * For example, `irange(1, 3)` will return `[1, 2, 3]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function irange(start: int, end?: int): int[];
 /**
  * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
  * be a non-zero value in reflections.
@@ -62,7 +81,8 @@ export declare function printEnabled(enabled: boolean, description: string): voi
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * repeat(10, () => {

package/dist/functions/utils.lua

@@ -8,6 +8,21 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local HEX_STRING_LENGTH = 6
 ____exports.ensureAllCases = function(____, obj) return obj end
+function ____exports.erange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i < ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
 function ____exports.getTraversalDescription(self, key, traversalDescription)
     if traversalDescription ~= "" then
         traversalDescription = traversalDescription .. " --> "
@@ -38,6 +53,21 @@ function ____exports.hexToKColor(self, hexString, alpha)
     local base = 255
     return KColor(R / base, G / base, B / base, alpha)
 end
+function ____exports.irange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i <= ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
 function ____exports.isReflectionRender(self)
     local room = game:GetRoom()
     local renderMode = room:GetRenderMode()

package/dist/functions/vector.d.ts

@@ -13,7 +13,7 @@ interface CopyVectorReturn {
  * Helper function to copy a `Vector` object.
  *
  * @param vector The vector to copy. In the case of deserialization, this will actually be a Lua
- * table instead of an instantiated Vector class.
+ *               table instead of an instantiated Vector class.
  * @param serializationType Default is `SerializationType.NONE`.
  */
 export declare function copyVector<V extends Vector | SerializedVector, S extends SerializationType>(vector: V, serializationType: S): CopyVectorReturn[S];

package/dist/types/CollectibleIndex.d.ts

@@ -3,7 +3,8 @@
  * [[`getCollectibleIndex`]] function. Mods can signify that data structures handle collectibles by
  * using this type.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const collectiblesNameMap = new Map<CollectibleIndex, string>();
  * ```

package/dist/types/PlayerIndex.d.ts

@@ -3,7 +3,8 @@
  * PlayerIndex is a specific type of string; see the documentation for the [[`getPlayerIndex`]]
  * function. Mods can signify that data structures handle `EntityPlayer` by using this type.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const playersNameMap = new Map<PlayerIndex, string>();
  * ```

package/dist/upgradeMod.d.ts

@@ -3,7 +3,8 @@ import { ModUpgraded } from "./classes/ModUpgraded";
 /**
  * Use this function to enable the custom features and callbacks provided by `isaacscript-common`.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const modVanilla = RegisterMod("My Mod", 1);
  * const mod = upgradeMod(modVanilla);
@@ -15,9 +16,6 @@ import { ModUpgraded } from "./classes/ModUpgraded";
  * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
  * ```
  *
- * For a list of all custom callbacks, check out the
- * [Function Signatures](https://isaacscript.github.io/docs/function-signatures#custom-callbacks).
- *
  * @param modVanilla The mod object returned by the `RegisterMod` function.
  * @returns The upgraded mod object.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.9",
+  "version": "2.0.12",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,12 +25,13 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.13"
+    "isaac-typescript-definitions": "^2.0.14"
   },
   "devDependencies": {
-    "isaacscript-lint": "^1.0.142",
+    "isaacscript-lint": "^1.0.150",
     "isaacscript-spell": "^1.0.3",
     "isaacscript-tsconfig": "^1.1.16",
+    "npm-check-updates": "^13.0.1",
     "ts-node": "^10.7.0",
     "typedoc": "^0.22.15",
     "typescript": "^4.6.4",