isaacscript-common 9.2.0 → 9.4.0

package/dist/callbacks/subscriptions/postGridEntityCollision.d.ts

@@ -1,8 +1,10 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 export declare type PostGridEntityCollisionRegisterParameters = [
     callback: (gridEntity: GridEntity, entity: Entity) => void,
     gridEntityType?: GridEntityType,
-    gridEntityVariant?: int
+    gridEntityVariant?: int,
+    entityType?: EntityType,
+    entityVariant?: int
 ];
 export declare function postGridEntityCollisionHasSubscriptions(): boolean;
 export declare function postGridEntityCollisionRegister(...args: PostGridEntityCollisionRegisterParameters): void;

package/dist/callbacks/subscriptions/postGridEntityCollision.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postGridEntityCollision.d.ts","sourceRoot":"","sources":["../../../src/callbacks/subscriptions/postGridEntityCollision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,oBAAY,yCAAyC,GAAG;IACtD,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI;IAC1D,cAAc,CAAC,EAAE,cAAc;IAC/B,iBAAiB,CAAC,EAAE,GAAG;CACxB,CAAC;AAIF,wBAAgB,uCAAuC,IAAI,OAAO,CAEjE;AAED,wBAAgB,+BAA+B,CAC7C,GAAG,IAAI,EAAE,yCAAyC,GACjD,IAAI,CAEN;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,GACb,IAAI,CA2BN"}
+{"version":3,"file":"postGridEntityCollision.d.ts","sourceRoot":"","sources":["../../../src/callbacks/subscriptions/postGridEntityCollision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE1E,oBAAY,yCAAyC,GAAG;IACtD,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI;IAC1D,cAAc,CAAC,EAAE,cAAc;IAC/B,iBAAiB,CAAC,EAAE,GAAG;IACvB,UAAU,CAAC,EAAE,UAAU;IACvB,aAAa,CAAC,EAAE,GAAG;CACpB,CAAC;AAIF,wBAAgB,uCAAuC,IAAI,OAAO,CAEjE;AAED,wBAAgB,+BAA+B,CAC7C,GAAG,IAAI,EAAE,yCAAyC,GACjD,IAAI,CAEN;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,GACb,IAAI,CA6CN"}

package/dist/callbacks/subscriptions/postGridEntityCollision.lua

@@ -14,6 +14,8 @@ function ____exports.postGridEntityCollisionFire(self, gridEntity, entity)
         local callback = ____value[1]
         local callbackGridEntityType = ____value[2]
         local callbackGridEntityVariant = ____value[3]
+        local callbackEntityType = ____value[4]
+        local callbackEntityVariant = ____value[5]
         do
             if callbackGridEntityType ~= nil and callbackGridEntityType ~= gridEntityType then
                 goto __continue5
@@ -21,6 +23,12 @@ function ____exports.postGridEntityCollisionFire(self, gridEntity, entity)
             if callbackGridEntityVariant ~= nil and callbackGridEntityVariant ~= gridEntityVariant then
                 goto __continue5
             end
+            if callbackEntityType ~= nil and callbackEntityType ~= entity.Type then
+                goto __continue5
+            end
+            if callbackEntityVariant ~= nil and callbackEntityVariant ~= entity.Variant then
+                goto __continue5
+            end
             callback(nil, gridEntity, entity)
         end
         ::__continue5::

package/dist/callbacks/subscriptions/postGridEntityCustomCollision.d.ts

@@ -1,7 +1,9 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 export declare type PostGridEntityCustomCollisionRegisterParameters = [
     callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType, entity: Entity) => void,
-    gridEntityTypeCustom?: GridEntityType
+    gridEntityTypeCustom?: GridEntityType,
+    entityType?: EntityType,
+    entityVariant?: int
 ];
 export declare function postGridEntityCustomCollisionHasSubscriptions(): boolean;
 export declare function postGridEntityCustomCollisionRegister(...args: PostGridEntityCustomCollisionRegisterParameters): void;

package/dist/callbacks/subscriptions/postGridEntityCustomCollision.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postGridEntityCustomCollision.d.ts","sourceRoot":"","sources":["../../../src/callbacks/subscriptions/postGridEntityCustomCollision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,oBAAY,+CAA+C,GAAG;IAC5D,QAAQ,EAAE,CACR,UAAU,EAAE,UAAU,EACtB,oBAAoB,EAAE,cAAc,EACpC,MAAM,EAAE,MAAM,KACX,IAAI;IACT,oBAAoB,CAAC,EAAE,cAAc;CACtC,CAAC;AAIF,wBAAgB,6CAA6C,IAAI,OAAO,CAEvE;AAED,wBAAgB,qCAAqC,CACnD,GAAG,IAAI,EAAE,+CAA+C,GACvD,IAAI,CAEN;AAED,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,UAAU,EACtB,oBAAoB,EAAE,cAAc,EACpC,MAAM,EAAE,MAAM,GACb,IAAI,CAYN"}
+{"version":3,"file":"postGridEntityCustomCollision.d.ts","sourceRoot":"","sources":["../../../src/callbacks/subscriptions/postGridEntityCustomCollision.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE1E,oBAAY,+CAA+C,GAAG;IAC5D,QAAQ,EAAE,CACR,UAAU,EAAE,UAAU,EACtB,oBAAoB,EAAE,cAAc,EACpC,MAAM,EAAE,MAAM,KACX,IAAI;IACT,oBAAoB,CAAC,EAAE,cAAc;IACrC,UAAU,CAAC,EAAE,UAAU;IACvB,aAAa,CAAC,EAAE,GAAG;CACpB,CAAC;AAIF,wBAAgB,6CAA6C,IAAI,OAAO,CAEvE;AAED,wBAAgB,qCAAqC,CACnD,GAAG,IAAI,EAAE,+CAA+C,GACvD,IAAI,CAEN;AAED,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,UAAU,EACtB,oBAAoB,EAAE,cAAc,EACpC,MAAM,EAAE,MAAM,GACb,IAAI,CAiCN"}

package/dist/callbacks/subscriptions/postGridEntityCustomCollision.lua

@@ -11,10 +11,18 @@ function ____exports.postGridEntityCustomCollisionFire(self, gridEntity, gridEnt
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]
         local callbackGridEntityTypeCustom = ____value[2]
+        local callbackEntityType = ____value[3]
+        local callbackEntityVariant = ____value[4]
         do
             if callbackGridEntityTypeCustom ~= nil and callbackGridEntityTypeCustom ~= gridEntityTypeCustom then
                 goto __continue5
             end
+            if callbackEntityType ~= nil and callbackEntityType ~= entity.Type then
+                goto __continue5
+            end
+            if callbackEntityVariant ~= nil and callbackEntityVariant ~= entity.Variant then
+                goto __continue5
+            end
             callback(nil, gridEntity, gridEntityTypeCustom, entity)
         end
         ::__continue5::

package/dist/core/constants.d.ts

@@ -116,6 +116,8 @@ export declare const MINUTE_IN_MILLISECONDS: number;
 export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
 /** After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount. */
 export declare const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
+/** For `GridEntityType.TELEPORTER` (23). */
+export declare const TELEPORTER_ACTIVATION_DISTANCE: number;
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
  * corner.

package/dist/core/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;GAIG;AAEH,eAAO,MAAM,+BAA+B,wDAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,QAAmB,CAAC;AAExE,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,QAAmB,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,gCAAgC,QAAmB,CAAC;AAEjE,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAkB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAsB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;GAIG;AAEH,eAAO,MAAM,+BAA+B,wDAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,QAAmB,CAAC;AAExE,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,QAAmB,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,gCAAgC,QAAmB,CAAC;AAEjE,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE,4CAA4C;AAC5C,eAAO,MAAM,8BAA8B,QAA4B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAkB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAsB,CAAC"}

package/dist/core/constants.lua

@@ -97,6 +97,8 @@ ____exports.MINUTE_IN_MILLISECONDS = 60 * ____exports.SECOND_IN_MILLISECONDS
 ____exports.ONE_BY_ONE_ROOM_GRID_SIZE = 135
 --- After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount.
 ____exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000
+--- For `GridEntityType.TELEPORTER` (23).
+____exports.TELEPORTER_ACTIVATION_DISTANCE = ____exports.DISTANCE_OF_GRID_TILE / 2
 --- This is the number of draw coordinates that each heart spans on the UI in the upper left hand
 -- corner.
 ____exports.UI_HEART_WIDTH = 12

package/dist/enums/ModCallbackCustom.d.ts

@@ -323,8 +323,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
@@ -339,8 +341,14 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided (for the grid entity).
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fifth argument that will make the callback
+     *   only fire if the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCollision(
@@ -355,7 +363,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomBroken(
@@ -369,8 +378,13 @@ export declare enum ModCallbackCustom {
      * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     *   variants, so there is no need for an optional third argument to filter by variant.)
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if the the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCustomCollision(
@@ -386,7 +400,8 @@ export declare enum ModCallbackCustom {
      * the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomInit(
@@ -401,7 +416,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRemove(
@@ -416,7 +432,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRender(
@@ -431,7 +448,8 @@ export declare enum ModCallbackCustom {
      * created with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomStateChanged(
@@ -448,7 +466,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomUpdate(
@@ -469,8 +488,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
      * callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityInit(gridEntity: GridEntity): void {}
@@ -488,8 +509,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityRemove(
@@ -502,14 +525,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
-     *
      * ```ts
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
@@ -519,12 +542,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
-     *
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
      *
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
+     *
      * ```ts
      * function postGridEntityStateChanged(
      *   gridEntity: GridEntity,
@@ -537,14 +562,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
-     *
      * ```ts
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
@@ -1166,7 +1191,8 @@ export declare enum ModCallbackCustom {
      * certain conditions, like if the slot entity is playing the "Idle" animation, and so on.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * only fire if it matches the `SlotVariant` provided. (There is no need for any additional
+     * arguments, since only players will cause this callback to fire.)
      *
      * ```ts
      * function postSlotCollision(

package/dist/enums/ModCallbackCustom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModCallbackCustom.d.ts","sourceRoot":"","sources":["../../src/enums/ModCallbackCustom.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,oBAAY,iBAAiB;IAC3B;;;;;;;;;;OAUG;IACH,oBAAoB,IAAA;IAEpB;;;;;;;;;;OAUG;IACH,mBAAmB,IAAA;IAEnB;;;;;;;;;OASG;IACH,kBAAkB,IAAA;IAElB;;;;;;;;;;;;OAYG;IACH,mBAAmB,IAAA;IAEnB;;;;;;OAMG;IACH,eAAe,IAAA;IAEf;;;;;;;;;;;;;OAaG;IACH,sBAAsB,IAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,IAAA;IAE3B;;;;;;;;OAQG;IACH,oBAAoB,IAAA;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,IAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,IAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;OAOG;IACH,YAAY,KAAA;IAEZ;;;;;;;;;;;;OAYG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;;OAUG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;OAWG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;OAWG;IACH,SAAS,KAAA;IAET;;;;;;;;;OASG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;OASG;IACH,gCAAgC,KAAA;IAEhC;;;;;;OAMG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;OAiBG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;;;;;OAaG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,iCAAiC,KAAA;IAEjC;;;;;;;;;;;;;OAaG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;;;;;OAaG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;OAaG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;;OAeG;IACH,qCAAqC,KAAA;IAErC;;;;;;;;;;;;;OAaG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;;;;OAiBG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;OAiBG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;OAYG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,6BAA6B,KAAA;IAE7B;;;;;;;;;;;OAWG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;OAaG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;OAYG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;;;;;;;OAkBG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;OAcG;IACH,6BAA6B,KAAA;IAE7B;;;;;;;;;;;;;;OAcG;IACH,+BAA+B,KAAA;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;;;;;;OAiBG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;OASG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;;;;OAYG;IACH,aAAa,KAAA;IAEb;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;OAUG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,cAAc,KAAA;IAEd;;;;;;;;;OASG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;OAcG;IACH,cAAc,KAAA;IAEd;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;OASG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,iBAAiB,KAAA;IAEjB;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,KAAA;IAEjB;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;OAYG;IACH,aAAa,KAAA;CACd"}
+{"version":3,"file":"ModCallbackCustom.d.ts","sourceRoot":"","sources":["../../src/enums/ModCallbackCustom.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,oBAAY,iBAAiB;IAC3B;;;;;;;;;;OAUG;IACH,oBAAoB,IAAA;IAEpB;;;;;;;;;;OAUG;IACH,mBAAmB,IAAA;IAEnB;;;;;;;;;OASG;IACH,kBAAkB,IAAA;IAElB;;;;;;;;;;;;OAYG;IACH,mBAAmB,IAAA;IAEnB;;;;;;OAMG;IACH,eAAe,IAAA;IAEf;;;;;;;;;;;;;OAaG;IACH,sBAAsB,IAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,IAAA;IAE3B;;;;;;;;OAQG;IACH,oBAAoB,IAAA;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,IAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,IAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;OAOG;IACH,YAAY,KAAA;IAEZ;;;;;;;;;;;;OAYG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;;OAUG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;OAWG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;OAWG;IACH,SAAS,KAAA;IAET;;;;;;;;;OASG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;OASG;IACH,gCAAgC,KAAA;IAEhC;;;;;;OAMG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iCAAiC,KAAA;IAEjC;;;;;;;;;;;;;;OAcG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;;;OAgBG;IACH,qCAAqC,KAAA;IAErC;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,8BAA8B,KAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;OAYG;IACH,oBAAoB,KAAA;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,6BAA6B,KAAA;IAE7B;;;;;;;;;;;OAWG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;OAaG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;OAYG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;;;;;;;OAkBG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;;;OAcG;IACH,6BAA6B,KAAA;IAE7B;;;;;;;;;;;;;;OAcG;IACH,+BAA+B,KAAA;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,sBAAsB,KAAA;IAEtB;;;;;;;;;;;;;;;;;OAiBG;IACH,qBAAqB,KAAA;IAErB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,4BAA4B,KAAA;IAE5B;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;OASG;IACH,0BAA0B,KAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,yBAAyB,KAAA;IAEzB;;;;;;;;;;;;OAYG;IACH,aAAa,KAAA;IAEb;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;;OAUG;IACH,uBAAuB,KAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,cAAc,KAAA;IAEd;;;;;;;;;OASG;IACH,2BAA2B,KAAA;IAE3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;;;OAcG;IACH,cAAc,KAAA;IAEd;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,gBAAgB,KAAA;IAEhB;;;;;;;;;OASG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;OASG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,wBAAwB,KAAA;IAExB;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;OASG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,KAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,kBAAkB,KAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,iBAAiB,KAAA;IAEjB;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,KAAA;IAEjB;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,KAAA;IAEf;;;;;;;;;;;;OAYG;IACH,aAAa,KAAA;CACd"}

package/dist/features/extraConsoleCommands/listCommands.lua

@@ -1054,7 +1054,7 @@ end
 -- "debug 10".
 function ____exports.spam(self)
     v.run.spamBloodRights = not v.run.spamBloodRights
-    printEnabled(nil, v.run.maxSpeed, "spamming Blood Rights")
+    printEnabled(nil, v.run.spamBloodRights, "spamming Blood Rights")
 end
 --- Spawns a golden version of the specified trinket type.
 function ____exports.spawnGoldenTrinket(self, params)

package/dist/functions/entities.d.ts

@@ -86,6 +86,10 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
+ * Use this helper function over checking if the velocity length is equal to 0 because entities can
+ * look like they are completely immobile but yet still have a non zero velocity. Thus, using a
+ * threshold is needed.
+ *
  * @param entity The entity whose velocity to measure.
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */

package/dist/functions/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/functions/entities.lua

@@ -235,6 +235,10 @@ function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
 end
 --- Helper function to measure an entity's velocity to see if it is moving.
 -- 
+-- Use this helper function over checking if the velocity length is equal to 0 because entities can
+-- look like they are completely immobile but yet still have a non zero velocity. Thus, using a
+-- threshold is needed.
+-- 
 -- @param entity The entity whose velocity to measure.
 -- @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
 function ____exports.isEntityMoving(self, entity, threshold)

package/dist/functions/rooms.d.ts

@@ -127,6 +127,7 @@ export declare function inDoubleTrouble(): boolean;
 export declare function inGenesisRoom(): boolean;
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
+/** Helper function to determine if the current room index is equal to `GridRoom.MEGA_SATAN`. */
 export declare function inMegaSatanRoom(): boolean;
 /**
  * Helper function to determine if the current room is part of the Repentance "escape sequence" in

package/dist/functions/rooms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,MAAM,EACN,SAAS,EAMT,YAAY,EACZ,UAAU,EAGV,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAkCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,GAC1B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAUlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAOlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAqBlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,cAAc,EAAE,CAWtD;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAStC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAShD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAIvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,wBAAgB,eAAe,IAAI,OAAO,CAIzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAWtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAItC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED,+DAA+D;AAC/D,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,MAAM,EACN,SAAS,EAMT,YAAY,EACZ,UAAU,EAGV,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAkCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,GAC1B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAUlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAOlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAqBlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,cAAc,EAAE,CAWtD;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAStC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAShD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAIvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,gGAAgG;AAChG,wBAAgB,eAAe,IAAI,OAAO,CAIzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAWtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAItC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED,+DAA+D;AAC/D,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}

package/dist/functions/rooms.lua

@@ -305,6 +305,7 @@ function ____exports.inLRoom(self)
     local roomShape = room:GetRoomShape()
     return roomShape == RoomShape.LTL or roomShape == RoomShape.LTR or roomShape == RoomShape.LBL or roomShape == RoomShape.LBR
 end
+--- Helper function to determine if the current room index is equal to `GridRoom.MEGA_SATAN`.
 function ____exports.inMegaSatanRoom(self)
     local roomGridIndex = getRoomGridIndex(nil)
     return roomGridIndex == asNumber(nil, GridRoom.MEGA_SATAN)

package/dist/functions/stage.d.ts

@@ -26,6 +26,10 @@ export declare function getStage(): LevelStage;
 export declare function getStageType(): StageType;
 /** Helper function to directly warp to a specific stage using the "stage" console command. */
 export declare function goToStage(stage: LevelStage, stageType: StageType): void;
+/**
+ * Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export declare function isRepentanceStage(stageType: StageType): boolean;
 export declare function onAscent(): boolean;
 export declare function onCathedral(): boolean;
@@ -47,6 +51,10 @@ export declare function onFinalFloor(): boolean;
  * first floor and The Ascent.
  */
 export declare function onFirstFloor(): boolean;
+/**
+ * Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export declare function onRepentanceStage(): boolean;
 export declare function onSheol(): boolean;
 /**

package/dist/functions/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAOtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,CASvC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAOtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,CASvC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/functions/stage.lua

@@ -14,9 +14,13 @@ local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
 local ____types = require("functions.types")
 local asLevelStage = ____types.asLevelStage
 local asNumber = ____types.asNumber
+--- Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
+-- `StageType.REPENTANCE_B`.
 function ____exports.isRepentanceStage(self, stageType)
     return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
 end
+--- Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
+-- `StageType.REPENTANCE_B`.
 function ____exports.onRepentanceStage(self)
     local level = game:GetLevel()
     local stageType = level:GetStageType()

package/dist/index.d.ts

@@ -5433,6 +5433,7 @@ export declare function initCustomDoor(mod: ModUpgraded, effectVariant: EffectVa
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
 
+/** Helper function to determine if the current room index is equal to `GridRoom.MEGA_SATAN`. */
 export declare function inMegaSatanRoom(): boolean;
 
 /**
@@ -5783,6 +5784,10 @@ export declare function isEntity(variable: unknown): variable is Entity;
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
+ * Use this helper function over checking if the velocity length is equal to 0 because entities can
+ * look like they are completely immobile but yet still have a non zero velocity. Thus, using a
+ * threshold is needed.
+ *
  * @param entity The entity whose velocity to measure.
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */
@@ -6049,6 +6054,10 @@ export declare function isReflectionRender(): boolean;
  */
 export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
 
+/**
+ * Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export declare function isRepentanceStage(stageType: StageType): boolean;
 
 /** Returns true for cards that have `ItemConfigCardType.TAROT_REVERSE`. */
@@ -7014,8 +7023,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
@@ -7030,8 +7041,14 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided (for the grid entity).
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fifth argument that will make the callback
+     *   only fire if the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCollision(
@@ -7046,7 +7063,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomBroken(
@@ -7060,8 +7078,13 @@ export declare enum ModCallbackCustom {
      * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     *   variants, so there is no need for an optional third argument to filter by variant.)
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if the the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCustomCollision(
@@ -7077,7 +7100,8 @@ export declare enum ModCallbackCustom {
      * the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomInit(
@@ -7092,7 +7116,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRemove(
@@ -7107,7 +7132,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRender(
@@ -7122,7 +7148,8 @@ export declare enum ModCallbackCustom {
      * created with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomStateChanged(
@@ -7139,7 +7166,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomUpdate(
@@ -7160,8 +7188,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
      * callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityInit(gridEntity: GridEntity): void {}
@@ -7179,8 +7209,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityRemove(
@@ -7193,14 +7225,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
-     *
      * ```ts
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
@@ -7210,12 +7242,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
-     *
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
      *
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
+     *
      * ```ts
      * function postGridEntityStateChanged(
      *   gridEntity: GridEntity,
@@ -7228,14 +7262,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
-     *
      * ```ts
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
@@ -7857,7 +7891,8 @@ export declare enum ModCallbackCustom {
      * certain conditions, like if the slot entity is playing the "Idle" animation, and so on.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * only fire if it matches the `SlotVariant` provided. (There is no need for any additional
+     * arguments, since only players will cause this callback to fire.)
      *
      * ```ts
      * function postSlotCollision(
@@ -8263,6 +8298,10 @@ export declare function onFinalFloor(): boolean;
  */
 export declare function onFirstFloor(): boolean;
 
+/**
+ * Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export declare function onRepentanceStage(): boolean;
 
 /**
@@ -8571,7 +8610,9 @@ gridEntityVariant?: int
 declare type PostGridEntityCollisionRegisterParameters = [
 callback: (gridEntity: GridEntity, entity: Entity) => void,
 gridEntityType?: GridEntityType,
-gridEntityVariant?: int
+gridEntityVariant?: int,
+entityType?: EntityType,
+entityVariant?: int
 ];
 
 declare type PostGridEntityCustomBrokenRegisterParameters = [
@@ -8581,7 +8622,9 @@ gridEntityTypeCustom?: GridEntityType
 
 declare type PostGridEntityCustomCollisionRegisterParameters = [
 callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType, entity: Entity) => void,
-gridEntityTypeCustom?: GridEntityType
+gridEntityTypeCustom?: GridEntityType,
+entityType?: EntityType,
+entityVariant?: int
 ];
 
 declare type PostGridEntityCustomInitRegisterParameters = [
@@ -11285,6 +11328,9 @@ export declare function tanh(x: number): number;
  */
 export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim, force?: boolean): void;
 
+/** For `GridEntityType.TELEPORTER` (23). */
+export declare const TELEPORTER_ACTIVATION_DISTANCE: number;
+
 /**
  * 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

package/package.json

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

package/src/callbacks/subscriptions/postGridEntityCollision.ts

@@ -1,9 +1,11 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 
 export type PostGridEntityCollisionRegisterParameters = [
   callback: (gridEntity: GridEntity, entity: Entity) => void,
   gridEntityType?: GridEntityType,
   gridEntityVariant?: int,
+  entityType?: EntityType,
+  entityVariant?: int,
 ];
 
 const subscriptions: PostGridEntityCollisionRegisterParameters[] = [];
@@ -29,6 +31,8 @@ export function postGridEntityCollisionFire(
     callback,
     callbackGridEntityType,
     callbackGridEntityVariant,
+    callbackEntityType,
+    callbackEntityVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -46,6 +50,22 @@ export function postGridEntityCollisionFire(
       continue;
     }
 
+    // Handle the optional 4th callback argument.
+    if (
+      callbackEntityType !== undefined &&
+      callbackEntityType !== entity.Type
+    ) {
+      continue;
+    }
+
+    // Handle the optional 5th callback argument.
+    if (
+      callbackEntityVariant !== undefined &&
+      callbackEntityVariant !== entity.Variant
+    ) {
+      continue;
+    }
+
     callback(gridEntity, entity);
   }
 }

package/src/callbacks/subscriptions/postGridEntityCustomCollision.ts

@@ -1,4 +1,4 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 
 export type PostGridEntityCustomCollisionRegisterParameters = [
   callback: (
@@ -7,6 +7,8 @@ export type PostGridEntityCustomCollisionRegisterParameters = [
     entity: Entity,
   ) => void,
   gridEntityTypeCustom?: GridEntityType,
+  entityType?: EntityType,
+  entityVariant?: int,
 ];
 
 const subscriptions: PostGridEntityCustomCollisionRegisterParameters[] = [];
@@ -26,7 +28,12 @@ export function postGridEntityCustomCollisionFire(
   gridEntityTypeCustom: GridEntityType,
   entity: Entity,
 ): void {
-  for (const [callback, callbackGridEntityTypeCustom] of subscriptions) {
+  for (const [
+    callback,
+    callbackGridEntityTypeCustom,
+    callbackEntityType,
+    callbackEntityVariant,
+  ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
       callbackGridEntityTypeCustom !== undefined &&
@@ -35,6 +42,22 @@ export function postGridEntityCustomCollisionFire(
       continue;
     }
 
+    // Handle the optional 3rd callback argument.
+    if (
+      callbackEntityType !== undefined &&
+      callbackEntityType !== entity.Type
+    ) {
+      continue;
+    }
+
+    // Handle the optional 4th callback argument.
+    if (
+      callbackEntityVariant !== undefined &&
+      callbackEntityVariant !== entity.Variant
+    ) {
+      continue;
+    }
+
     callback(gridEntity, gridEntityTypeCustom, entity);
   }
 }

package/src/core/constants.ts

@@ -161,6 +161,9 @@ export const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
 /** After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount. */
 export const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
 
+/** For `GridEntityType.TELEPORTER` (23). */
+export const TELEPORTER_ACTIVATION_DISTANCE = DISTANCE_OF_GRID_TILE / 2;
+
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
  * corner.

package/src/enums/ModCallbackCustom.ts

@@ -356,8 +356,10 @@ export enum ModCallbackCustom {
    * For grid entities created with `spawnCustomGridEntity`, use the
    * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if it matches the variant provided.
    *
    * ```ts
    * function postGridEntityBroken(gridEntity: GridEntity): void {}
@@ -373,8 +375,14 @@ export enum ModCallbackCustom {
    * For grid entities created with `spawnCustomGridEntity`, use the
    * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if it matches the variant provided (for the grid entity).
+   * - When registering the callback, takes an optional fourth argument that will make the callback
+   *   only fire if the colliding entity matches the `EntityType` provided.
+   * - When registering the callback, takes an optional fifth argument that will make the callback
+   *   only fire if the colliding entity matches the variant provided.
    *
    * ```ts
    * function postGridEntityCollision(
@@ -390,7 +398,8 @@ export enum ModCallbackCustom {
    * with the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomBroken(
@@ -405,8 +414,13 @@ export enum ModCallbackCustom {
    * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
    * with the `spawnCustomGridEntity` helper function.
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   *   variants, so there is no need for an optional third argument to filter by variant.)
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if the the colliding entity matches the `EntityType` provided.
+   * - When registering the callback, takes an optional fourth argument that will make the callback
+   *   only fire if the the colliding entity matches the variant provided.
    *
    * ```ts
    * function postGridEntityCustomCollision(
@@ -423,7 +437,8 @@ export enum ModCallbackCustom {
    * the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomInit(
@@ -439,7 +454,8 @@ export enum ModCallbackCustom {
    * with the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomRemove(
@@ -455,7 +471,8 @@ export enum ModCallbackCustom {
    * with the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomRender(
@@ -471,7 +488,8 @@ export enum ModCallbackCustom {
    * created with the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomStateChanged(
@@ -489,7 +507,8 @@ export enum ModCallbackCustom {
    * with the `spawnCustomGridEntity` helper function.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+   * variants, so there is no need for an optional third argument to filter by variant.)
    *
    * ```ts
    * function postGridEntityCustomUpdate(
@@ -511,8 +530,10 @@ export enum ModCallbackCustom {
    * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
    * callback instead.
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if it matches the variant provided.
    *
    * ```ts
    * function postGridEntityInit(gridEntity: GridEntity): void {}
@@ -531,8 +552,10 @@ export enum ModCallbackCustom {
    * For grid entities created with `spawnCustomGridEntity`, use the
    * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if it matches the variant provided.
    *
    * ```ts
    * function postGridEntityRemove(
@@ -546,14 +569,14 @@ export enum ModCallbackCustom {
   /**
    * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
    *
+   * For grid entities created with `spawnCustomGridEntity`, use the
+   * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
+   *
    * - When registering the callback, takes an optional second argument that will make the callback
    *   only fire if it matches the `GridEntityType` provided.
    * - When registering the callback, takes an optional third argument that will make the callback
    *   only fire if it matches the variant provided.
    *
-   * For grid entities created with `spawnCustomGridEntity`, use the
-   * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
-   *
    * ```ts
    * function postGridEntityRender(gridEntity: GridEntity): void {}
    * ```
@@ -564,12 +587,14 @@ export enum ModCallbackCustom {
    * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
    * "state" refers to the `GridEntity.State` field.)
    *
-   * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `GridEntityType` provided.
-   *
    * For grid entities created with `spawnCustomGridEntity`, use the
    * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
    *
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if it matches the `GridEntityType` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if it matches the variant provided.
+   *
    * ```ts
    * function postGridEntityStateChanged(
    *   gridEntity: GridEntity,
@@ -583,14 +608,14 @@ export enum ModCallbackCustom {
   /**
    * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
    *
+   * For grid entities created with `spawnCustomGridEntity`, use the
+   * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
+   *
    * - When registering the callback, takes an optional second argument that will make the callback
    *   only fire if it matches the `GridEntityType` provided.
    * - When registering the callback, takes an optional third argument that will make the callback
    *   only fire if it matches the variant provided.
    *
-   * For grid entities created with `spawnCustomGridEntity`, use the
-   * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
-   *
    * ```ts
    * function postGridEntityUpdate(gridEntity: GridEntity): void {}
    * ```
@@ -1251,7 +1276,8 @@ export enum ModCallbackCustom {
    * certain conditions, like if the slot entity is playing the "Idle" animation, and so on.
    *
    * When registering the callback, takes an optional second argument that will make the callback
-   * only fire if it matches the `SlotVariant` provided.
+   * only fire if it matches the `SlotVariant` provided. (There is no need for any additional
+   * arguments, since only players will cause this callback to fire.)
    *
    * ```ts
    * function postSlotCollision(

package/src/features/extraConsoleCommands/listCommands.ts

@@ -1249,7 +1249,7 @@ export function sounds(): void {
  */
 export function spam(): void {
   v.run.spamBloodRights = !v.run.spamBloodRights;
-  printEnabled(v.run.maxSpeed, "spamming Blood Rights");
+  printEnabled(v.run.spamBloodRights, "spamming Blood Rights");
 }
 
 /** Spawns a golden version of the specified trinket type. */

package/src/functions/entities.ts

@@ -234,6 +234,10 @@ export function getFilteredNewEntities<T extends AnyEntity>(
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
+ * Use this helper function over checking if the velocity length is equal to 0 because entities can
+ * look like they are completely immobile but yet still have a non zero velocity. Thus, using a
+ * threshold is needed.
+ *
  * @param entity The entity whose velocity to measure.
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */

package/src/functions/rooms.ts

@@ -388,6 +388,7 @@ export function inLRoom(): boolean {
   );
 }
 
+/** Helper function to determine if the current room index is equal to `GridRoom.MEGA_SATAN`. */
 export function inMegaSatanRoom(): boolean {
   const roomGridIndex = getRoomGridIndex();
 

package/src/functions/stage.ts

@@ -116,6 +116,10 @@ export function goToStage(stage: LevelStage, stageType: StageType): void {
   Isaac.ExecuteCommand(command);
 }
 
+/**
+ * Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export function isRepentanceStage(stageType: StageType): boolean {
   return (
     stageType === StageType.REPENTANCE || stageType === StageType.REPENTANCE_B
@@ -191,6 +195,10 @@ export function onFirstFloor(): boolean {
   return effectiveStage === 1 && !isOnAscent;
 }
 
+/**
+ * Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
+ * `StageType.REPENTANCE_B`.
+ */
 export function onRepentanceStage(): boolean {
   const level = game.GetLevel();
   const stageType = level.GetStageType();