isaacscript-common 2.1.0 → 2.2.0

package/README.md

@@ -2,6 +2,6 @@
 
 [![npm version](https://img.shields.io/npm/v/isaacscript-common.svg)](https://www.npmjs.com/package/isaacscript-common)
 
-This package contains helper functions and extra features for IsaacScript mods. Start by [browsing the auto-generated documentation](https://isaacscript.github.io/docs/api).
+This package contains helper functions and extra features for IsaacScript mods. Start by [browsing the auto-generated documentation](https://isaacscript.github.io/isaacscript-common).
 
 For more information about IsaacScript, see the [official website](https://isaacscript.github.io/).

package/classes/DefaultMap.d.ts

@@ -1,6 +1,6 @@
 /**
  * A function that creates the value for your default map. For example, if it was a default map
- * containing a map, the factory function would be: `() => new Map()`
+ * containing maps, the factory function would be: `() => new Map()`
  */
 export declare type FactoryFunction<V, Args extends unknown[]> = (...extraArgs: Args) => V;
 declare type FirstArg<K, V, Args extends unknown[]> = Iterable<[K, V]> | V | FactoryFunction<V, Args>;

package/classes/ModUpgraded.d.ts

@@ -1,7 +1,13 @@
 import { ModCallback } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { AddCallbackParameterCustom } from "../types/AddCallbackParameterCustom";
-/** `isaacscript-common` allows for custom callbacks, so it provides an upgraded Mod object. */
+import { AddCallbackParameterCustom } from "../interfaces/AddCallbackParameterCustom";
+/**
+ * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
+ * hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
+ * extends the base class and adds a new method of `AddCallbackCustom`.
+ *
+ * To upgrade your mod, use the `upgradeMod` helper function.
+ */
 export declare class ModUpgraded implements Mod {
     Name: string;
     /** We store a copy of the original mod object so that we can re-implement its functions. */

package/constants.d.ts

@@ -14,7 +14,7 @@ export declare const BOMB_EXPLODE_FRAME = 45;
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;
-export declare const DOOR_HITBOX_DISTANCE = 11;
+export declare const DOOR_HITBOX_RADIUS = 11;
 /**
  * When Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and spawn 14 Swarm Spiders
  * while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this
@@ -93,12 +93,12 @@ export declare const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
  */
 export declare const UI_HEART_WIDTH = 12;
 /**
- * This is a safer version of the `Vector.One` constant. (Other mods can mutate this vector, so it
- * is not safe to use.)
+ * This is a safer version of the `Vector.One` constant. (Other mods can mutate this `Vector.One`,
+ * so it is not safe to use.)
  */
 export declare const VectorOne: Readonly<Vector>;
 /**
- * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate this vector, so it
- * is not safe to use.)
+ * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`
+ * vector, so it is not safe to use.)
  */
 export declare const VectorZero: Readonly<Vector>;

package/constants.lua

@@ -13,7 +13,7 @@ ____exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 ____exports.BOMB_EXPLODE_FRAME = 45
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE
 ____exports.DISTANCE_OF_GRID_TILE = 40
-____exports.DOOR_HITBOX_DISTANCE = 11
+____exports.DOOR_HITBOX_RADIUS = 11
 ____exports.EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45
 ____exports.EMPTY_PNG_PATH = "gfx/none.png"
 ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1

package/enums/HealthType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This represents the type of health that is either given or taken away from a player. Note that we
- * cannot use the HeartSubType enum for this purpose this since it has no value for broken hearts or
- * max hearts.
+ * cannot use the `HeartSubType` enum for this purpose this since it has no value for broken hearts
+ * or max hearts.
  */
 export declare enum HealthType {
     RED = 0,