isaacscript-common 1.2.256 → 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/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/package.json

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