isaacscript-common 9.2.1 → 9.4.1

package/dist/index.d.ts

@@ -1748,7 +1748,7 @@ export declare function deserializeRNG(rng: SerializedRNG): RNG;
  */
 export declare function deserializeVector(vector: SerializedVector): Vector;
 
-/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76) */
+/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76). */
 export declare const DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75;
 
 export declare function directionToDegrees(direction: Direction): int;
@@ -5559,7 +5559,7 @@ export declare function isArrayContiguous(array: int[]): boolean;
 /** Checks if an array is in the provided 2-dimensional array. */
 export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
 
-/** For `PickupVariant.LIL_BATTERY` (90) */
+/** For `PickupVariant.LIL_BATTERY` (90). */
 export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery;
 
 /**
@@ -5578,7 +5578,7 @@ export declare function isBlindCollectible(collectible: EntityPickup): boolean;
 /** Helper function to detect if a variable is of type `EntityBomb`. */
 export declare function isBomb(variable: unknown): variable is EntityBomb;
 
-/** For `PickupVariant.BOMB` (40) */
+/** For `PickupVariant.BOMB` (40). */
 export declare function isBombPickup(pickup: EntityPickup): pickup is EntityPickupBomb;
 
 export declare function isBoolean(variable: unknown): variable is boolean;
@@ -5592,7 +5592,7 @@ export declare function isBoolean(variable: unknown): variable is boolean;
  */
 export declare function isCard(cardType: CardType): boolean;
 
-/** For `PickupVariant.TAROT_CARD` (300) */
+/** For `PickupVariant.TAROT_CARD` (300). */
 export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
 
 /** Returns whether or not the given card type matches the specified item config card type. */
@@ -5622,10 +5622,10 @@ export declare function isCircleIntersectingRectangle(circleCenter: Vector, circ
 /** Helper function to see if a player is close enough to activate a Dice Room floor. */
 export declare function isCloseEnoughToTriggerDiceFloor(player: EntityPlayer, diceFloor: EntityEffect): boolean;
 
-/** For `PickupVariant.COIN` (20) */
+/** For `PickupVariant.COIN` (20). */
 export declare function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin;
 
-/** For `PickupVariant.COLLECTIBLE` (100) */
+/** For `PickupVariant.COLLECTIBLE` (100). */
 export declare function isCollectible(pickup: EntityPickup): pickup is EntityPickupCollectible;
 
 /**
@@ -5784,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.
  */
@@ -5836,7 +5840,7 @@ export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity)
  */
 export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
 
-/** For `PickupVariant.HEART` (10) */
+/** For `PickupVariant.HEART` (10). */
 export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
 
 /**
@@ -5880,7 +5884,7 @@ export declare function isKColor(object: unknown): object is KColor;
  */
 export declare function isKeeper(player: EntityPlayer): boolean;
 
-/** For `PickupVariant.KEY` (30) */
+/** For `PickupVariant.KEY` (30). */
 export declare function isKey(pickup: EntityPickup): pickup is EntityPickupKey;
 
 /**
@@ -5979,7 +5983,7 @@ export declare function isPickingUpItemTrinket(pickingUpItem: PickingUpItem): pi
 /** Helper function to detect if a variable is of type `EntityPickup`. */
 export declare function isPickup(variable: unknown): variable is EntityPickup;
 
-/** For `PickupVariant.PILL` (70) */
+/** For `PickupVariant.PILL` (70). */
 export declare function isPill(pickup: EntityPickup): pickup is EntityPickupPill;
 
 /** Helper function to detect if a variable is of type `GridEntityPit`. */
@@ -6000,7 +6004,7 @@ export declare function isPocketItemObject(cardType: CardType): boolean;
 /** Helper function to detect if a variable is of type `GridEntityPoop`. */
 export declare function isPoop(variable: unknown): variable is GridEntityPoop;
 
-/** For `PickupVariant.POOP` (42) */
+/** For `PickupVariant.POOP` (42). */
 export declare function isPoopPickup(pickup: EntityPickup): pickup is EntityPickupPoop;
 
 /**
@@ -6085,7 +6089,7 @@ export declare function isRoomShapeDoubleCharge(roomShape: RoomShape): boolean;
 /** Returns true for cards that have `CardType.RUNE`. */
 export declare function isRune(cardType: CardType): boolean;
 
-/** For `PickupVariant.SACK` (69) */
+/** For `PickupVariant.SACK` (69). */
 export declare function isSack(pickup: EntityPickup): pickup is EntityPickupSack;
 
 /**
@@ -6156,7 +6160,7 @@ export declare function isSin(npc: EntityNPC): boolean;
  */
 export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
 
-/** For `EntityType.SLOT` (6) */
+/** For `EntityType.SLOT` (6). */
 export declare function isSlot(entity: Entity): entity is EntitySlot;
 
 /** Returns true for cards that have `CardType.SPECIAL`. */
@@ -6196,7 +6200,7 @@ export declare function isTNT(variable: unknown): variable is GridEntityTNT;
 
 export declare function isTransformationFlying(playerForm: PlayerForm): boolean;
 
-/** For `PickupVariant.TRINKET` (350) */
+/** For `PickupVariant.TRINKET` (350). */
 export declare function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket;
 
 /**
@@ -7019,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 {}
@@ -7035,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(
@@ -7051,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(
@@ -7065,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(
@@ -7082,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(
@@ -7097,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(
@@ -7112,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(
@@ -7127,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(
@@ -7144,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(
@@ -7165,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 {}
@@ -7184,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(
@@ -7198,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 {}
      * ```
@@ -7215,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,
@@ -7233,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 {}
      * ```
@@ -7862,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(
@@ -8580,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 = [
@@ -8590,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 = [
@@ -11294,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.1",
+  "version": "9.4.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^4.0.0"
+    "isaac-typescript-definitions": "^4.0.1"
   }
 }

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(