isaacscript-common 1.2.76 → 1.2.79

package/dist/callbacks/postPurchase.lua

@@ -9,8 +9,8 @@ local ____exports = {}
 local hasSubscriptions, postUpdate, checkPickupsPurchased, getPlayerThatIsNoLongerHoldingAnItem, storePickupsInMap, storePlayersInMap, pickupAtIndexStillExists, v
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
-local ____entity = require("functions.entity")
-local getPickups = ____entity.getPickups
+local ____pickups = require("functions.pickups")
+local getPickups = ____pickups.getPickups
 local ____player = require("functions.player")
 local getPlayerIndex = ____player.getPlayerIndex
 local getPlayers = ____player.getPlayers

package/dist/callbacks/postSlotInitUpdate.lua

@@ -6,8 +6,8 @@ local ____exports = {}
 local hasSubscriptions, postUpdate, postNewRoom, checkNewEntity, v
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
-local ____entity = require("functions.entity")
-local getSlots = ____entity.getSlots
+local ____entitySpecific = require("functions.entitySpecific")
+local getSlots = ____entitySpecific.getSlots
 local ____postSlotInit = require("callbacks.subscriptions.postSlotInit")
 local postSlotInitFire = ____postSlotInit.postSlotInitFire
 local postSlotInitHasSubscriptions = ____postSlotInit.postSlotInitHasSubscriptions

package/dist/callbacks/postSlotRenderBroken.lua

@@ -6,8 +6,8 @@ local ____exports = {}
 local hasSubscriptions, postRender, checkSlotBroken, BROKEN_ANIMATIONS, v
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
-local ____entity = require("functions.entity")
-local getSlots = ____entity.getSlots
+local ____entitySpecific = require("functions.entitySpecific")
+local getSlots = ____entitySpecific.getSlots
 local ____postSlotDestroyed = require("callbacks.subscriptions.postSlotDestroyed")
 local postSlotDestroyedFire = ____postSlotDestroyed.postSlotDestroyedFire
 local postSlotDestroyedHasSubscriptions = ____postSlotDestroyed.postSlotDestroyedHasSubscriptions

package/dist/constants.d.ts

@@ -24,6 +24,7 @@ export declare const CHARACTERS_WITH_NO_RED_HEARTS: ReadonlySet<PlayerType>;
  * includes The Lost and Tainted Lost.
  */
 export declare const CHARACTERS_WITH_NO_SOUL_HEARTS: ReadonlySet<PlayerType>;
+export declare const CHEST_PICKUP_VARIANTS: ReadonlySet<PickupVariant>;
 /**
  * A collection of common colors that can be reused. Note that if you want to further modify these
  * colors, you should copy them first with the `copyColor` function.

package/dist/constants.lua

@@ -38,6 +38,20 @@ ____exports.CHARACTERS_WITH_NO_SOUL_HEARTS = __TS__New(Set, {
     PlayerType.PLAYER_THELOST_B,
     PlayerType.PLAYER_KEEPER_B
 })
+____exports.CHEST_PICKUP_VARIANTS = __TS__New(Set, {
+    PickupVariant.PICKUP_CHEST,
+    PickupVariant.PICKUP_BOMBCHEST,
+    PickupVariant.PICKUP_SPIKEDCHEST,
+    PickupVariant.PICKUP_ETERNALCHEST,
+    PickupVariant.PICKUP_MIMICCHEST,
+    PickupVariant.PICKUP_OLDCHEST,
+    PickupVariant.PICKUP_WOODENCHEST,
+    PickupVariant.PICKUP_MEGACHEST,
+    PickupVariant.PICKUP_HAUNTEDCHEST,
+    PickupVariant.PICKUP_LOCKEDCHEST,
+    PickupVariant.PICKUP_REDCHEST,
+    PickupVariant.PICKUP_MOMSCHEST
+})
 ____exports.COLORS = {
     Black = Color(1, 1, 1),
     Red = Color(1, 0, 0),

package/dist/features/deployJSONRoom.d.ts

@@ -10,6 +10,8 @@ import { JSONRoom } from "../types/JSONRoom";
  * @param jsonRoom The JSON room to deploy. In practice, this will be something like:
  * ```
  * import customRooms from "./customRooms";
+import { removeAllPickups } from '../functions/pickups';
+import { removeAllBombs } from '../functions/entitySpecific';
  *
  * const firstJSONRoom = customRooms.rooms.room[0];
  * deployJSONRoom(firstJSONRoom);

package/dist/features/deployJSONRoom.lua

@@ -10,9 +10,9 @@ local postNewRoom, setDecorationsInvisible, respawnPersistentEntities, removeSpe
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____entity = require("functions.entity")
-local removeAllBombs = ____entity.removeAllBombs
 local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
-local removeAllPickups = ____entity.removeAllPickups
+local ____entitySpecific = require("functions.entitySpecific")
+local removeAllBombs = ____entitySpecific.removeAllBombs
 local ____gridEntity = require("functions.gridEntity")
 local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
 local getGridEntities = ____gridEntity.getGridEntities
@@ -27,6 +27,8 @@ local ____math = require("functions.math")
 local range = ____math.range
 local ____npc = require("functions.npc")
 local getNPCs = ____npc.getNPCs
+local ____pickups = require("functions.pickups")
+local removeAllPickups = ____pickups.removeAllPickups
 local ____random = require("functions.random")
 local nextSeed = ____random.nextSeed
 local ____rooms = require("functions.rooms")

package/dist/functions/array.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * Helper function for determining if two arrays contain the exact same elements. Note that this
+ * only performs a shallow comparison.
+ */
+export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] | readonly T[]): boolean;
 /**
  * Helper function to combine two or more arrays. Returns a new array that is the composition of all
  * of the specified arrays. This function is variadic, meaning that you can specify N arguments to
@@ -15,11 +20,8 @@ export declare function combineArray<T>(...arrays: Array<T[] | readonly T[]>): T
  */
 export declare function copyArray<T>(oldArray: T[] | readonly T[], numElements?: int): T[];
 export declare function emptyArray<T>(array: T[]): void;
-/**
- * Helper function for determining if two arrays contain the exact same elements. Note that this
- * only performs a shallow comparison.
- */
-export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] | readonly T[]): boolean;
+/** Helper function to return the last element of an array. */
+export declare function getLastElement<T>(array: T[]): T;
 /**
  * Initializes an array with all elements containing the specified default value.
  *

package/dist/functions/array.lua

@@ -1,8 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArraySplice = ____lualib.__TS__ArraySplice
-local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayReduce = ____lualib.__TS__ArrayReduce
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
@@ -35,8 +35,19 @@ function ____exports.getRandomArrayIndex(self, array, seed)
     if #array == 0 then
         error("Failed to get a random array index since the provided array is empty.")
     end
-    local randomIndex = getRandomInt(nil, 0, #array - 1, seed)
-    return randomIndex
+    return getRandomInt(nil, 0, #array - 1, seed)
+end
+function ____exports.arrayEquals(self, array1, array2)
+    if #array1 ~= #array2 then
+        return false
+    end
+    return __TS__ArrayEvery(
+        array1,
+        function(____, array1Element, i)
+            local array2Element = array2[i + 1]
+            return array1Element == array2Element
+        end
+    )
 end
 function ____exports.combineArray(self, ...)
     local arrays = {...}
@@ -66,17 +77,8 @@ end
 function ____exports.emptyArray(self, array)
     __TS__ArraySplice(array, 0, #array)
 end
-function ____exports.arrayEquals(self, array1, array2)
-    if #array1 ~= #array2 then
-        return false
-    end
-    return __TS__ArrayEvery(
-        array1,
-        function(____, array1Element, i)
-            local array2Element = array2[i + 1]
-            return array1Element == array2Element
-        end
-    )
+function ____exports.getLastElement(self, array)
+    return array[#array]
 end
 function ____exports.initArray(self, defaultValue, size)
     local array = {}

package/dist/functions/collectibles.lua

@@ -8,11 +8,11 @@ local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local ____collectibleNameMap = require("maps.collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
-local ____entity = require("functions.entity")
-local getPickups = ____entity.getPickups
-local removeAllPickups = ____entity.removeAllPickups
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
+local ____pickups = require("functions.pickups")
+local getPickups = ____pickups.getPickups
+local removeAllPickups = ____pickups.removeAllPickups
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
 function ____exports.setCollectibleSprite(self, collectible, pngPath)

package/dist/functions/entity.d.ts

@@ -1,18 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 import { AnyEntity } from "../types/AnyEntity";
 export declare function anyEntityCloserThan(entities: Entity[], position: Vector, distance: int): boolean;
-/**
- * Helper function to get all of the bombs in the room.
- *
- * Example:
- * ```
- * // Make all of the bombs in the room invisible
- * for (const bomb of getBombs()) {
- *   bomb.Visible = false;
- * }
- * ```
- */
-export declare function getBombs(matchingVariant?: BombVariant | int, matchingSubType?: number): EntityBomb[];
 /**
  * Given an array of entities, this helper function returns the closest one to a provided reference
  * entity.
@@ -24,24 +12,12 @@ export declare function getBombs(matchingVariant?: BombVariant | int, matchingSu
  * const closestGaper = getClosestEntityTo(player, gapers);
  * ```
  */
-export declare function getClosestEntityTo(referenceEntity: Entity, entities: Entity[]): Entity;
+export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T;
 /**
  * Helper function to compare two different arrays of entities. Returns the entities that are in the
  * second array but not in the first array.
  */
 export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities: T[], newEntities: T[]): T[];
-/**
- * Helper function to get all of the effects in the room.
- *
- * Example:
- * ```
- * // Make all of the effects in the room invisible
- * for (const effect of getEffects()) {
- *   effect.Visible = false;
- * }
- * ```
- */
-export declare function getEffects(matchingVariant?: EffectVariant | int, matchingSubType?: number): EntityEffect[];
 /**
  * Helper function to get all of the entities in the room or all of the entities that match a
  * specific entity type / variant / sub-type.
@@ -66,86 +42,6 @@ export declare function getEffects(matchingVariant?: EffectVariant | int, matchi
  * returned. False by default. Will only be taken into account if `matchingEntityType` is specified.
  */
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
-/**
- * Helper function to get a map containing the positions of every entity in the current room.
- *
- * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions()`.
- *
- * @param entities Optional. If provided, will only get the positions of the provided entities. This
- * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
- */
-export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector>;
-/**
- * Helper function to get a map containing the velocities of every entity in the current room.
- *
- * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities()`.
- *
- * @param entities Optional. If provided, will only get the velocities of the provided entities.
- * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
- * times.
- */
-export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
-/**
- * Helper function to get all of the knives in the room.
- *
- * Example:
- * ```
- * // Make all of the knives in the room invisible
- * for (const knife of getKnives()) {
- *   knife.Visible = false;
- * }
- * ```
- */
-export declare function getKnives(matchingVariant?: KnifeVariant | int, matchingSubType?: number): EntityKnife[];
-/**
- * Helper function to get all of the lasers in the room.
- *
- * Example:
- * ```
- * // Make all of the lasers in the room invisible
- * for (const laser of getLasers()) {
- *   laser.Visible = false;
- * }
- * ```
- */
-export declare function getLasers(matchingVariant?: LaserVariant | int, matchingSubType?: number): EntityLaser[];
-/**
- * Helper function to get all of the pickups in the room.
- *
- * Example:
- * ```
- * // Make all of the pickups in the room invisible
- * for (const pickup of getPickups()) {
- *   pickup.Visible = false;
- * }
- * ```
- */
-export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
-/**
- * Helper function to get all of the projectiles in the room.
- *
- * Example:
- * ```
- * // Make all of the projectiles in the room invisible
- * for (const projectile of getProjectiles()) {
- *   projectile.Visible = false;
- * }
- * ```
- */
-export declare function getProjectiles(matchingVariant?: ProjectileVariant | int, matchingSubType?: number): EntityProjectile[];
-export declare function getSlots(matchingVariant?: SlotVariant | int, matchingSubType?: number): Entity[];
-/**
- * Helper function to get all of the tears in the room.
- *
- * Example:
- * ```
- * // Make all of the tears in the room invisible
- * for (const tear of getTears()) {
- *   tear.Visible = false;
- * }
- * ```
- */
-export declare function getTears(matchingVariant?: TearVariant | int, matchingSubType?: number): EntityTear[];
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
@@ -159,50 +55,6 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  * to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
  */
 export declare function isStoryBoss(entity: Entity): boolean;
-/**
- * Helper function to remove all of the entities in the supplied array.
- *
- * @param entities The array of entities to remove.
- * @param cap Optional. If specified, will only remove the given amount of entities.
- * @returns True if one or more entities was removed, false otherwise.
- */
-export declare function removeEntities(entities: Entity[], cap?: int): boolean;
-/**
- * Helper function to remove all of the bombs in the room.
- *
- * @param variant Optional. If specified, will only remove bombs that match this variant.
- * @param subType Optional. If specified, will only remove bombs that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of bombs.
- * @returns True if one or more bombs was removed, false otherwise.
- */
-export declare function removeAllBombs(variant?: BombVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the effects in the room.
- *
- * @param variant Optional. If specified, will only remove effects that match this variant.
- * @param subType Optional. If specified, will only remove effects that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of effects.
- * @returns True if one or more effects was removed, false otherwise.
- */
-export declare function removeAllEffects(variant?: EffectVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the knives in the room.
- *
- * @param variant Optional. If specified, will only remove knives that match this variant.
- * @param subType Optional. If specified, will only remove knives that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of knives.
- * @returns True if one or more knives was removed, false otherwise.
- */
-export declare function removeAllKnives(variant?: KnifeVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the lasers in the room.
- *
- * @param variant Optional. If specified, will only remove lasers that match this variant.
- * @param subType Optional. If specified, will only remove lasers that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of lasers.
- * @returns True if one or more lasers was removed, false otherwise.
- */
-export declare function removeAllLasers(variant?: LaserVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the matching entities in the room.
  *
@@ -216,66 +68,20 @@ export declare function removeAllLasers(variant?: LaserVariant | int, subType?:
  */
 export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): boolean;
 /**
- * Helper function to remove all of the pickups in the room.
- *
- * @param variant Optional. If specified, will only remove pickups that match this variant.
- * @param subType Optional. If specified, will only remove pickups that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of pickups.
- * @returns True if one or more pickups was removed, false otherwise.
- */
-export declare function removeAllPickups(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the projectiles in the room.
- *
- * @param variant Optional. If specified, will only remove projectiles that match this variant.
- * @param subType Optional. If specified, will only remove projectiles that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of projectiles.
- * @returns True if one or more projectiles was removed, false otherwise.
- */
-export declare function removeAllProjectiles(variant?: ProjectileVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the tears in the room.
- *
- * @param variant Optional. If specified, will only remove tears that match this variant.
- * @param subType Optional. If specified, will only remove tears that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of tears.
- * @returns True if one or more tears was removed, false otherwise.
- */
-export declare function removeAllTears(variant?: TearVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Game().RerollEnemy rerolls a boolean of whether or not the enemy was rerolled. However, you
- * cannot use the same entity object after a reroll. This function calls game.RerollEnemy and
- * returns the new entity object.
+ * Helper function to remove all of the entities in the supplied array.
  *
- * @param entity The entity to reroll
- * @returns If the entity was not rerolled, returns the original entity. otherwise, returns the resulting entity from the reroll
+ * @param entities The array of entities to remove.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns True if one or more entities was removed, false otherwise.
  */
-export declare function rerollEnemy(entity: Entity): Entity;
+export declare function removeEntities(entities: Entity[], cap?: int): boolean;
 /**
- * Helper function to set the position of every entity in the room based on a map of positions. If
- * an entity is found that does not have matching element in the provided map, then that entity will
- * be skipped.
- *
- * This function is useful for rewinding entity positions at a later time. Also see
- * `getEntityPositions()`.
+ * Helper function to reroll an enemy. Use this instead of the vanilla "Game.RerollEnemy" function
+ * if you want the rerolled enemy to be returned.
  *
- * @param entityPositions The map providing the positions for every entity.
- * @param entities Optional. If provided, will only set the positions of the provided entities. This
- * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
+ * @param entity The entity to reroll.
+ * @returns If the game failed to reroll the enemy, returns undefined. Otherwise, returns the
+ * rerolled entity.
  */
-export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>, entities?: Entity[]): void;
+export declare function rerollEnemy(entity: Entity): Entity | undefined;
 export declare function setEntityRandomColor(entity: Entity): void;
-/**
- * Helper function to set the velocity of every entity in the room based on a map of velocities. If
- * an entity is found that does not have matching element in the provided map, then that entity will
- * be skipped.
- *
- * This function is useful for rewinding entity velocities at a later time. Also see
- * `getEntityVelocities()`.
- *
- * @param entityVelocities The map providing the velocities for every entity.
- * @param entities Optional. If provided, will only set the velocities of the provided entities.
- * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
- * times.
- */
-export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vector>, entities?: Entity[]): void;