isaacscript-common 9.2.1 → 9.4.1

package/src/features/customStage/customStageGridEntities.ts

@@ -25,7 +25,7 @@ import {
 import { DEFAULT_BASE_STAGE } from "./exports";
 import v from "./v";
 
-/** For `GridEntityType.DECORATION` (1) */
+/** For `GridEntityType.DECORATION` (1). */
 export function setCustomDecorationGraphics(
   customStage: CustomStage,
   gridEntity: GridEntity,
@@ -71,7 +71,7 @@ export function setCustomDecorationGraphics(
   }
 }
 
-/** For `GridEntityType.ROCK` (2) */
+/** For `GridEntityType.ROCK` (2). */
 export function setCustomRockGraphics(
   customStage: CustomStage,
   gridEntity: GridEntity,
@@ -134,7 +134,7 @@ export function setCustomRockGraphics(
   }
 }
 
-/** For `GridEntityType.PIT` (7) */
+/** For `GridEntityType.PIT` (7). */
 export function setCustomPitGraphics(
   customStage: CustomStage,
   gridEntity: GridEntity,
@@ -164,7 +164,7 @@ export function setCustomPitGraphics(
   }
 }
 
-/** For GridEntityType.DOOR (16) */
+/** For `GridEntityType.DOOR` (16). */
 export function setCustomDoorGraphics(
   customStage: CustomStage,
   gridEntity: GridEntity,

package/src/functions/effects.ts

@@ -1,6 +1,6 @@
 import { inRectangle } from "./math";
 
-/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76) */
+/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76). */
 export const DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75;
 
 /** Helper function to see if a player is close enough to activate a Dice Room floor. */

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/entityTypes.ts

@@ -1,6 +1,6 @@
 import { EntityType } from "isaac-typescript-definitions";
 
-/** For `EntityType.SLOT` (6) */
+/** For `EntityType.SLOT` (6). */
 export function isSlot(entity: Entity): entity is EntitySlot {
   return entity.Type === EntityType.SLOT;
 }

package/src/functions/pickupVariants.ts

@@ -2,59 +2,59 @@
 
 import { PickupVariant } from "isaac-typescript-definitions";
 
-/** For `PickupVariant.HEART` (10) */
+/** For `PickupVariant.HEART` (10). */
 export function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart {
   return pickup.Variant === PickupVariant.HEART;
 }
 
-/** For `PickupVariant.COIN` (20) */
+/** For `PickupVariant.COIN` (20). */
 export function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin {
   return pickup.Variant === PickupVariant.COIN;
 }
 
-/** For `PickupVariant.KEY` (30) */
+/** For `PickupVariant.KEY` (30). */
 export function isKey(pickup: EntityPickup): pickup is EntityPickupKey {
   return pickup.Variant === PickupVariant.KEY;
 }
 
-/** For `PickupVariant.BOMB` (40) */
+/** For `PickupVariant.BOMB` (40). */
 export function isBombPickup(pickup: EntityPickup): pickup is EntityPickupBomb {
   return pickup.Variant === PickupVariant.BOMB;
 }
 
-/** For `PickupVariant.POOP` (42) */
+/** For `PickupVariant.POOP` (42). */
 export function isPoopPickup(pickup: EntityPickup): pickup is EntityPickupPoop {
   return pickup.Variant === PickupVariant.POOP;
 }
 
-/** For `PickupVariant.SACK` (69) */
+/** For `PickupVariant.SACK` (69). */
 export function isSack(pickup: EntityPickup): pickup is EntityPickupSack {
   return pickup.Variant === PickupVariant.SACK;
 }
 
-/** For `PickupVariant.PILL` (70) */
+/** For `PickupVariant.PILL` (70). */
 export function isPill(pickup: EntityPickup): pickup is EntityPickupPill {
   return pickup.Variant === PickupVariant.PILL;
 }
 
-/** For `PickupVariant.LIL_BATTERY` (90) */
+/** For `PickupVariant.LIL_BATTERY` (90). */
 export function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery {
   return pickup.Variant === PickupVariant.LIL_BATTERY;
 }
 
-/** For `PickupVariant.COLLECTIBLE` (100) */
+/** For `PickupVariant.COLLECTIBLE` (100). */
 export function isCollectible(
   pickup: EntityPickup,
 ): pickup is EntityPickupCollectible {
   return pickup.Variant === PickupVariant.COLLECTIBLE;
 }
 
-/** For `PickupVariant.TAROT_CARD` (300) */
+/** For `PickupVariant.TAROT_CARD` (300). */
 export function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard {
   return pickup.Variant === PickupVariant.TAROT_CARD;
 }
 
-/** For `PickupVariant.TRINKET` (350) */
+/** For `PickupVariant.TRINKET` (350). */
 export function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket {
   return pickup.Variant === PickupVariant.TRINKET;
 }