isaacscript-common 1.2.254 → 1.2.257

package/dist/constants.d.ts

@@ -116,5 +116,13 @@ export declare const TRINKET_ID_MASK = 32767;
  * corner.
  */
 export declare const UI_HEART_WIDTH = 12;
+/**
+ * This is a safer version of the `Vector.One` constant. (Other mods can mutate this vector, so it
+ * is not safe to use.)
+ */
 export declare const VectorOne: ReadonlyVector;
+/**
+ * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate this vector, so it
+ * is not safe to use.)
+ */
 export declare const VectorZero: ReadonlyVector;

package/dist/functions/color.d.ts

@@ -19,6 +19,7 @@ export declare function colorEquals(color1: Color, color2: Color): boolean;
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
 export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
+/** Returns `Color(1, 1, 1)`. */
 export declare function getDefaultColor(): Color;
 /** Helper function to check if something is an instantiated Color object. */
 export declare function isColor(object: unknown): object is Color;

package/dist/functions/entity.d.ts

@@ -66,7 +66,7 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
  * to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
  */
-export declare function isStoryBoss(entity: Entity): boolean;
+export declare function isStoryBoss(entityType: EntityType | int): boolean;
 /**
  * Helper function to remove all of the matching entities in the room.
  *

package/dist/functions/entity.lua

@@ -108,8 +108,8 @@ function ____exports.isEntityMoving(self, entity, threshold)
     end
     return entity.Velocity:Length() >= threshold
 end
-function ____exports.isStoryBoss(self, entity)
-    return STORY_BOSSES_SET:has(entity.Type)
+function ____exports.isStoryBoss(self, entityType)
+    return STORY_BOSSES_SET:has(entityType)
 end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then

package/dist/functions/entitySpecific.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
 /**
  * Helper function to get all of the `EntityType.ENTITY_BOMB` in the room.
  *
@@ -218,7 +219,7 @@ export declare function spawnLaser(variant: LaserVariant | int, subType: int, po
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7) with a specific seed. */
 export declare function spawnLaserWithSeed(variant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
 /** Helper function to spawn an NPC. */
-export declare function spawnNPC(entityType: EntityType | int, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityNPC;
+export declare function spawnNPC<T extends number>(entityType: T extends EntityTypeNonNPC ? never : T, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityNPC;
 /** Helper function to spawn an NPC with a specific seed. */
 export declare function spawnNPCWithSeed(entityType: EntityType | int, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5). */

package/dist/functions/kColor.d.ts

@@ -18,6 +18,7 @@ interface CopyKColorReturn {
  */
 export declare function copyKColor<K extends KColor | SerializedKColor, S extends SerializationType>(kColor: K, serializationType: S): CopyKColorReturn[S];
 export declare function copyKColor<K extends KColor | SerializedKColor>(kColor: K): CopyKColorReturn[SerializationType.NONE];
+/** Returns `KColor(1, 1, 1, 1)`. */
 export declare function getDefaultKColor(): KColor;
 /** Helper function to check if something is an instantiated KColor object. */
 export declare function isKColor(object: unknown): object is KColor;

package/dist/functions/pickups.d.ts

@@ -3,6 +3,11 @@
 export declare function getBatteries(matchingSubType?: number): EntityPickup[];
 /** Helper function to get all of the card entities in the room. */
 export declare function getCards(matchingSubType?: number): EntityPickup[];
+/**
+ * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
+ * sub-types.
+ */
+export declare function getCoinValue(coinSubType: CoinSubType): int;
 /** Helper function to get all of the coin pickup entities in the room. */
 export declare function getCoins(matchingSubType?: number): EntityPickup[];
 /** Helper function to get all of the collectible entities in the room. */

package/dist/functions/pickups.lua

@@ -3,6 +3,9 @@ local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
+local ____coinSubTypeToValue = require("objects.coinSubTypeToValue")
+local COIN_SUBTYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUBTYPE_TO_VALUE
+local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
 local ____chestPickupVariantsSet = require("sets.chestPickupVariantsSet")
 local CHEST_PICKUP_VARIANTS = ____chestPickupVariantsSet.CHEST_PICKUP_VARIANTS
 local ____redHeartSubTypesSet = require("sets.redHeartSubTypesSet")
@@ -23,6 +26,10 @@ function ____exports.getCards(self, matchingSubType)
     end
     return getPickups(nil, 300, matchingSubType)
 end
+function ____exports.getCoinValue(self, coinSubType)
+    local value = COIN_SUBTYPE_TO_VALUE[coinSubType]
+    return value == nil and DEFAULT_COIN_VALUE or value
+end
 function ____exports.getCoins(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1

package/dist/objects/coinSubTypeToValue.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const DEFAULT_COIN_VALUE = 1;
+export declare const COIN_SUBTYPE_TO_VALUE: {
+    readonly [key in CoinSubType]: int;
+};

package/dist/objects/coinSubTypeToValue.lua

@@ -0,0 +1,13 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.DEFAULT_COIN_VALUE = 1
+____exports.COIN_SUBTYPE_TO_VALUE = {
+    [CoinSubType.COIN_PENNY] = 1,
+    [CoinSubType.COIN_NICKEL] = 5,
+    [CoinSubType.COIN_DIME] = 10,
+    [CoinSubType.COIN_DOUBLEPACK] = 2,
+    [CoinSubType.COIN_LUCKYPENNY] = 1,
+    [CoinSubType.COIN_STICKYNICKEL] = 5,
+    [CoinSubType.COIN_GOLDEN] = 1
+}
+return ____exports

package/dist/types/EntityTypeNonNPC.d.ts

@@ -0,0 +1,2 @@
+/** We cannot use EntityType values directly since it will break the exclusion hack. */
+export declare type EntityTypeNonNPC = 1 | 2 | 3 | 4 | 5 | 7 | 8 | 9 | 1000;

package/dist/types/EntityTypeNonNPC.lua

@@ -0,0 +1,3 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.254",
+  "version": "1.2.257",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",