isaacscript-common 2.0.11 → 2.0.14

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,13 +8,13 @@ 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;
+export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean): EntityPickup;
 /**
  * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
  * with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
@@ -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/transformations.d.ts

@@ -9,7 +9,7 @@ import { CollectibleType, PlayerForm } from "isaac-typescript-definitions";
  * const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
  * ```
  */
-export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType | int>;
+export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType>;
 /** Returns the number of items that a player has towards a particular transformation. */
 export declare function getPlayerNumCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): int;
 /** Returns a set of the player's current transformations. */
@@ -17,13 +17,14 @@ 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"
  * ```
  */
 export declare function getTransformationName(playerForm: PlayerForm): string;
-export declare function getTransformationsForCollectibleType(collectibleType: CollectibleType | int): Set<PlayerForm>;
+export declare function getTransformationsForCollectibleType(collectibleType: CollectibleType): Set<PlayerForm>;
 export declare function hasFlyingTransformation(player: EntityPlayer): boolean;
 export declare function isTransformationFlying(playerForm: PlayerForm): boolean;

package/dist/functions/trinketCacheFlag.d.ts

@@ -3,8 +3,8 @@ import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
  * Returns a map containing every trinket type that the player has that matches the provided
  * CacheFlag. The values of the map correspond to the multiplier for that trinket.
  */
-export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType | int, int>;
+export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
 /**
  * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
  */
-export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType | int>;
+export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType>;

package/dist/functions/trinketGive.d.ts

@@ -14,9 +14,9 @@ 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;
+export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType, numTrinkets?: number): void;
 /**
  * Helper function to temporarily remove a specific kind of trinket from the player. Use this in
  * combination with the `giveTrinketsBack` function to take away and give back a trinket on the same
@@ -27,7 +27,7 @@ export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketT
  *
  * @returns Undefined if the player does not have the trinket, or TrinketSituation if they do.
  */
-export declare function temporarilyRemoveTrinket(player: EntityPlayer, trinketType: TrinketType | int): TrinketSituation | undefined;
+export declare function temporarilyRemoveTrinket(player: EntityPlayer, trinketType: TrinketType): TrinketSituation | undefined;
 /**
  * Helper function to temporarily removes a player's held trinkets, if any. This will not remove any
  * smelted trinkets. Use this in combination with the `giveTrinketsBack` function to take away and

package/dist/functions/trinketSet.d.ts

@@ -1,3 +1,3 @@
 import { TrinketType } from "isaac-typescript-definitions";
 /** Returns a set containing every valid trinket type in the game, including modded items. */
-export declare function getTrinketSet(): Set<TrinketType | int>;
+export declare function getTrinketSet(): Set<TrinketType>;

package/dist/functions/trinkets.d.ts

@@ -5,11 +5,12 @@ import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
  * For example, passing `TrinketType.SWALLOWED_PENNY` would result in 32769, which is the value that
  * corresponds to the golden trinket sub-type for Swallowed Penny.
  */
-export declare function getGoldenTrinketType(trinketType: TrinketType | int): TrinketType | int;
+export declare function getGoldenTrinketType(trinketType: TrinketType): TrinketType;
 /**
  * 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);
@@ -24,18 +25,19 @@ export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefine
  * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
  * trinket type was not valid.
  */
-export declare function getTrinketDescription(trinketType: TrinketType | int): string;
+export declare function getTrinketDescription(trinketType: TrinketType): string;
 /**
  * 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"
  * ```
  */
-export declare function getTrinketName(trinketType: TrinketType | int): string;
+export declare function getTrinketName(trinketType: TrinketType): string;
 /**
  * Returns whether or not the player can hold an additional trinket, beyond what they are currently
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
@@ -44,7 +46,7 @@ export declare function getTrinketName(trinketType: TrinketType | int): string;
  * items. (Only Tainted Forgotten can pick up items.)
  */
 export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
-export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean;
+export declare function isGoldenTrinket(trinketType: TrinketType): boolean;
 /**
  * Helper function to change the sprite of a trinket entity.
  *
@@ -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;
+export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;

package/dist/functions/trinkets.lua

@@ -44,7 +44,7 @@ function ____exports.getTrinketDescription(self, trinketType)
     if trinketDescription ~= nil then
         return trinketDescription
     end
-    local itemConfigItem = itemConfig:GetCollectible(trinketType)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
     if itemConfigItem ~= nil then
         return itemConfigItem.Description
     end
@@ -55,7 +55,7 @@ function ____exports.getTrinketName(self, trinketType)
     if trinketName ~= nil then
         return trinketName
     end
-    local itemConfigItem = itemConfig:GetCollectible(trinketType)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
     if itemConfigItem ~= nil then
         return itemConfigItem.Name
     end

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,
@@ -80,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/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/index.d.ts

@@ -62,6 +62,7 @@ export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
 export * from "./functions/kColor";
 export * from "./functions/language";
+export * from "./functions/level";
 export * from "./functions/log";
 export * from "./functions/map";
 export * from "./functions/math";

package/dist/index.lua

@@ -509,6 +509,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.level")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.log")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/objects/roomShapeToDoorSlots.d.ts

@@ -1,4 +1,4 @@
 import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
 export declare const ROOM_SHAPE_TO_DOOR_SLOTS: {
-    readonly [key in RoomShape]: ReadonlySet<DoorSlot> | undefined;
+    readonly [key in RoomShape]: ReadonlySet<DoorSlot>;
 };

package/dist/objects/roomShapeToDoorSlotsToGridIndexDelta.lua

@@ -6,11 +6,11 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local ____constants = require("constants")
-local LEVEL_GRID_ROW_LENGTH = ____constants.LEVEL_GRID_ROW_LENGTH
+local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
 local LEFT = -1
-local UP = -LEVEL_GRID_ROW_LENGTH
+local UP = -LEVEL_GRID_ROW_WIDTH
 local RIGHT = 1
-local DOWN = LEVEL_GRID_ROW_LENGTH
+local DOWN = LEVEL_GRID_ROW_WIDTH
 ____exports.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = {
     [RoomShape.SHAPE_1x1] = __TS__New(Map, {{DoorSlot.LEFT_0, LEFT}, {DoorSlot.UP_0, UP}, {DoorSlot.RIGHT_0, RIGHT}, {DoorSlot.DOWN_0, DOWN}}),
     [RoomShape.IH] = __TS__New(Map, {{DoorSlot.LEFT_0, LEFT}, {DoorSlot.RIGHT_0, RIGHT}}),

package/dist/sets/mineShaftRoomSubTypesSet.d.ts

@@ -0,0 +1,2 @@
+import { MinesRoomSubType } from "isaac-typescript-definitions";
+export declare const MINE_SHAFT_ROOM_SUB_TYPE_SET: ReadonlySet<MinesRoomSubType>;

package/dist/sets/mineShaftRoomSubTypesSet.lua

@@ -0,0 +1,14 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local MinesRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.MinesRoomSubType
+____exports.MINE_SHAFT_ROOM_SUB_TYPE_SET = __TS__New(Set, {
+    MinesRoomSubType.MINESHAFT_ENTRANCE,
+    MinesRoomSubType.MINESHAFT_LOBBY,
+    MinesRoomSubType.MINESHAFT_KNIFE_PIECE,
+    MinesRoomSubType.MINESHAFT_ROOM_PRE_CHASE,
+    MinesRoomSubType.MINESHAFT_ROOM_POST_CHASE
+})
+return ____exports

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/PickingUpItem.d.ts

@@ -3,7 +3,7 @@ export interface PickingUpItem {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType;
     /** Equal to either the collectible type or the trinket type. */
-    subType: CollectibleType | TrinketType | int;
+    subType: CollectibleType | TrinketType;
 }
 export declare function newPickingUpItem(): PickingUpItem;
 export declare function resetPickingUpItem(pickingUpItem: PickingUpItem): void;

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/types/TrinketSituation.d.ts

@@ -1,7 +1,7 @@
 import { TrinketType } from "isaac-typescript-definitions";
 export interface TrinketSituation {
-    trinketTypeRemoved: TrinketType | int;
-    trinketType1: TrinketType | int;
-    trinketType2: TrinketType | int;
+    trinketTypeRemoved: TrinketType;
+    trinketType1: TrinketType;
+    trinketType2: TrinketType;
     numSmeltedTrinkets: int;
 }

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.11",
+  "version": "2.0.14",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,12 +25,13 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.14"
+    "isaac-typescript-definitions": "^2.0.19"
   },
   "devDependencies": {
-    "isaacscript-lint": "^1.0.145",
+    "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",