isaacscript-common 73.1.1 → 75.0.0

package/dist/functions/pickups.lua

@@ -0,0 +1,141 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local ____constants = require("core.constants")
+local CHEST_PICKUP_VARIANTS_SET = ____constants.CHEST_PICKUP_VARIANTS_SET
+local ____batteryNames = require("objects.batteryNames")
+local BATTERY_NAMES = ____batteryNames.BATTERY_NAMES
+local DEFAULT_BATTERY_NAME = ____batteryNames.DEFAULT_BATTERY_NAME
+local ____bombNames = require("objects.bombNames")
+local BOMB_NAMES = ____bombNames.BOMB_NAMES
+local DEFAULT_BOMB_NAME = ____bombNames.DEFAULT_BOMB_NAME
+local ____chestNames = require("objects.chestNames")
+local CHEST_NAMES = ____chestNames.CHEST_NAMES
+local DEFAULT_CHEST_NAME = ____chestNames.DEFAULT_CHEST_NAME
+local ____coinNames = require("objects.coinNames")
+local COIN_NAMES = ____coinNames.COIN_NAMES
+local DEFAULT_COIN_NAME = ____coinNames.DEFAULT_COIN_NAME
+local ____coinSubTypeToValue = require("objects.coinSubTypeToValue")
+local COIN_SUB_TYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUB_TYPE_TO_VALUE
+local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
+local ____heartNames = require("objects.heartNames")
+local DEFAULT_HEART_NAME = ____heartNames.DEFAULT_HEART_NAME
+local HEART_NAMES = ____heartNames.HEART_NAMES
+local ____keyNames = require("objects.keyNames")
+local DEFAULT_KEY_NAME = ____keyNames.DEFAULT_KEY_NAME
+local KEY_NAMES = ____keyNames.KEY_NAMES
+local ____sackNames = require("objects.sackNames")
+local DEFAULT_SACK_NAME = ____sackNames.DEFAULT_SACK_NAME
+local SACK_NAMES = ____sackNames.SACK_NAMES
+local ____redHeartSubTypesSet = require("sets.redHeartSubTypesSet")
+local RED_HEART_SUB_TYPES_SET = ____redHeartSubTypesSet.RED_HEART_SUB_TYPES_SET
+local ____entities = require("functions.entities")
+local removeEntities = ____entities.removeEntities
+local ____pickupVariants = require("functions.pickupVariants")
+local isHeart = ____pickupVariants.isHeart
+local ____pickupsSpecific = require("functions.pickupsSpecific")
+local getHearts = ____pickupsSpecific.getHearts
+--- Helper function to test if the provided pickup variant matches one of the various chest variants.
+function ____exports.isChestVariant(self, pickupVariant)
+    return CHEST_PICKUP_VARIANTS_SET:has(pickupVariant)
+end
+--- Helper function to get the name of a battery, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided battery sub-type is not valid.
+-- 
+-- This function only works for vanilla battery types.
+-- 
+-- For example, `getBatteryName(BatterySubType.MICRO)` would return "Micro Battery".
+function ____exports.getBatteryName(self, batterySubType)
+    return BATTERY_NAMES[batterySubType] or DEFAULT_BATTERY_NAME
+end
+--- Helper function to get the name of a bomb, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided bomb sub-type is not valid.
+-- 
+-- This function only works for vanilla bomb types.
+-- 
+-- For example, `getBombName(BombSubType.DOUBLE_PACK)` would return "Double Bomb".
+function ____exports.getBombName(self, bombSubType)
+    return BOMB_NAMES[bombSubType] or DEFAULT_BOMB_NAME
+end
+--- Helper function to get the name of a chest, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the pickup variant was not a chest.
+-- 
+-- This function only works for vanilla chest types.
+-- 
+-- For example, `getChestName(PickupVariant.SPIKED_CHEST)` would return "Spiked Chest".
+function ____exports.getChestName(self, pickupVariant)
+    local chestNames = CHEST_NAMES
+    return chestNames[pickupVariant] or DEFAULT_CHEST_NAME
+end
+--- Helper function to get the name of a coin, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided coin sub-type is not valid.
+-- 
+-- This function only works for vanilla chest types.
+-- 
+-- For example, `getCoinName(CoinSubType.DOUBLE_PACK)` would return "Double Penny".
+function ____exports.getCoinName(self, coinSubType)
+    return COIN_NAMES[coinSubType] or DEFAULT_COIN_NAME
+end
+--- Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
+-- sub-types.
+function ____exports.getCoinValue(self, coinSubType)
+    local value = COIN_SUB_TYPE_TO_VALUE[coinSubType]
+    return value or DEFAULT_COIN_VALUE
+end
+--- Helper function to get the name of a heart, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided heart sub-type is not valid.
+-- 
+-- This function only works for vanilla heart types.
+-- 
+-- For example, `getHeartName(HeartSubType.ETERNAL)` would return "Heart (eternal)".
+function ____exports.getHeartName(self, heartSubType)
+    return HEART_NAMES[heartSubType] or DEFAULT_HEART_NAME
+end
+--- Helper function to get the name of a key, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided key sub-type is not valid.
+-- 
+-- This function only works for vanilla key types.
+-- 
+-- For example, `getKeyName(KeySubType.DOUBLE_PACK)` would return "Key Ring".
+function ____exports.getKeyName(self, keySubType)
+    return KEY_NAMES[keySubType] or DEFAULT_KEY_NAME
+end
+--- Helper function to get all of the red heart pickup entities in the room.
+function ____exports.getRedHearts(self)
+    local hearts = getHearts(nil)
+    return __TS__ArrayFilter(
+        hearts,
+        function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
+    )
+end
+--- Helper function to get the name of a sack, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided sack sub-type is not valid.
+-- 
+-- This function only works for vanilla sack types.
+-- 
+-- For example, `getSackName(SackSubType.NORMAL)` would return "Grab Bag".
+function ____exports.getSackName(self, sackSubType)
+    return SACK_NAMES[sackSubType] or DEFAULT_SACK_NAME
+end
+--- Helper function to test if the provided pickup matches one of the various chest variants.
+function ____exports.isChest(self, pickup)
+    return ____exports.isChestVariant(nil, pickup.Variant)
+end
+--- Helper function to test if the provided pickup matches one of the various red heart sub-types.
+function ____exports.isRedHeart(self, pickup)
+    return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
+end
+--- Helper function to test if the provided heart sub-type matches one of the various red heart
+-- sub-types.
+function ____exports.isRedHeartSubType(self, heartSubType)
+    return RED_HEART_SUB_TYPES_SET:has(heartSubType)
+end
+--- Helper function to remove all of the red heart pickup entities in the room.
+-- 
+-- @param cap Optional. If specified, will only remove the given amount of hearts.
+-- @returns The red hearts that were removed.
+function ____exports.removeAllRedHearts(self, cap)
+    local redHearts = ____exports.getRedHearts(nil)
+    return removeEntities(nil, redHearts, cap)
+end
+return ____exports

package/dist/functions/pickupsSpecific.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickupsSpecific.d.ts","sourceRoot":"","sources":["../../src/functions/pickupsSpecific.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,QAAQ,EACR,WAAW,EACX,eAAe,EACf,YAAY,EACZ,UAAU,EACV,SAAS,EACT,WAAW,EACX,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAKtC;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,cAAc,GAAE,cAAc,GAAG,CAAC,CAAM,GACvC,mBAAmB,EAAE,CAKvB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,WAAW,GAAE,WAAW,GAAG,CAAC,CAAM,GACjC,gBAAgB,EAAE,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,GAAE,QAAQ,GAAG,CAAC,CAAM,GAAG,gBAAgB,EAAE,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,GAAE,WAAW,GAAG,CAAC,CAAM,GACjC,gBAAgB,EAAE,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,eAAe,GAAE,eAAe,GAAG,CAAC,CAAM,GACzC,uBAAuB,EAAE,CAK3B;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,YAAY,GAAE,YAAY,GAAG,CAAC,CAAM,GACnC,iBAAiB,EAAE,CAErB;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,UAAU,GAAE,UAAU,GAAG,CAAC,CAAM,GAAG,eAAe,EAAE,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,SAAS,GAAE,SAAS,GAAG,CAAC,CAAM,GAAG,gBAAgB,EAAE,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,GAAE,WAAW,GAAG,CAAC,CAAM,GACjC,gBAAgB,EAAE,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,WAAW,GAAE,WAAW,GAAG,CAAC,CAAM,GACjC,mBAAmB,EAAE,CAKvB;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,cAAc,GAAE,cAAc,GAAG,CAAC,CAAM,EACxC,GAAG,CAAC,EAAE,GAAG,GACR,mBAAmB,EAAE,CAMvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,GAAE,WAAW,GAAG,CAAC,CAAM,EAClC,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAMpB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,GAAE,QAAQ,GAAG,CAAC,CAAM,EAC5B,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAMpB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,WAAW,CAAC,EAAE,WAAW,EACzB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAMpB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,eAAe,CAAC,EAAE,eAAe,EACjC,GAAG,CAAC,EAAE,GAAG,GACR,uBAAuB,EAAE,CAM3B;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,YAAY,CAAC,EAAE,YAAY,EAC3B,GAAG,CAAC,EAAE,GAAG,GACR,iBAAiB,EAAE,CAMrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,UAAU,CAAC,EAAE,UAAU,EACvB,GAAG,CAAC,EAAE,GAAG,GACR,eAAe,EAAE,CAMnB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,SAAS,CAAC,EAAE,SAAS,EACrB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAMpB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,WAAW,CAAC,EAAE,WAAW,EACzB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAMpB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,CAAC,EAAE,WAAW,EACzB,GAAG,CAAC,EAAE,GAAG,GACR,mBAAmB,EAAE,CAMvB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAC1B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,mBAAmB,CASrB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,mBAAmB,CAQrB;AAED,iGAAiG;AACjG,wBAAgB,eAAe,CAC7B,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,gBAAgB,CASlB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,gBAAgB,CAQlB;AAED,kGAAkG;AAClG,wBAAgB,SAAS,CACvB,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,gBAAgB,CASlB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,gBAAgB,CAElB;AAED,iGAAiG;AACjG,wBAAgB,SAAS,CACvB,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,gBAAgB,CASlB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,gBAAgB,CAQlB;AAED,kGAAkG;AAClG,wBAAgB,UAAU,CACxB,YAAY,EAAE,YAAY,EAC1B,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,iBAAiB,CASnB;AAED,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,YAAY,EAC1B,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,iBAAiB,CAQnB;AAED,gGAAgG;AAChG,wBAAgB,QAAQ,CACtB,UAAU,EAAE,UAAU,EACtB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,eAAe,CASjB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,UAAU,EACtB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,eAAe,CAQjB;AAED,iGAAiG;AACjG,wBAAgB,SAAS,CACvB,SAAS,EAAE,SAAS,EACpB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,gBAAgB,CASlB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,gBAAgB,CAQlB;AAED,iGAAiG;AACjG,wBAAgB,SAAS,CACvB,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,gBAAgB,CASlB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,gBAAgB,CAQlB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,mBAAmB,CASrB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,mBAAmB,CAQrB"}

package/dist/functions/pickupsSpecific.lua

@@ -0,0 +1,479 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____constants = require("core.constants")
+local VectorZero = ____constants.VectorZero
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getPickups = ____entitiesSpecific.getPickups
+local removeAllPickups = ____entitiesSpecific.removeAllPickups
+local spawnPickup = ____entitiesSpecific.spawnPickup
+--- Helper function to get all of the battery entities in the room.
+-- 
+-- @param batterySubType Optional. If specified, will only get the batteries that match the
+-- sub-type. Default is -1, which matches every sub-type.
+function ____exports.getBatteries(self, batterySubType)
+    if batterySubType == nil then
+        batterySubType = -1
+    end
+    return getPickups(nil, PickupVariant.LIL_BATTERY, batterySubType)
+end
+--- Helper function to get all of the bomb entities in the room. (Specifically, this refers to bomb
+-- pickups, not the `EntityBomb` class.)
+-- 
+-- @param bombSubType Optional. If specified, will only get the bombs that match the sub-type.
+-- Default is -1, which matches every sub-type.
+function ____exports.getBombPickups(self, bombSubType)
+    if bombSubType == nil then
+        bombSubType = -1
+    end
+    return getPickups(nil, PickupVariant.BOMB, bombSubType)
+end
+--- Helper function to get all of the card entities in the room.
+-- 
+-- @param cardType Optional. If specified, will only get the cards that match the sub-type. Default
+-- is -1, which matches every sub-type.
+function ____exports.getCards(self, cardType)
+    if cardType == nil then
+        cardType = -1
+    end
+    return getPickups(nil, PickupVariant.CARD, cardType)
+end
+--- Helper function to get all of the coin pickup entities in the room.
+-- 
+-- @param coinSubType Optional. If specified, will only get the coins that match the sub-type.
+-- Default is -1, which matches every sub-type.
+function ____exports.getCoins(self, coinSubType)
+    if coinSubType == nil then
+        coinSubType = -1
+    end
+    return getPickups(nil, PickupVariant.COIN, coinSubType)
+end
+--- Helper function to get all of the collectible entities in the room.
+-- 
+-- @param collectibleType Optional. If specified, will only get the collectibles that match the
+-- sub-type. Default is -1, which matches every sub-type.
+function ____exports.getCollectibles(self, collectibleType)
+    if collectibleType == nil then
+        collectibleType = -1
+    end
+    return getPickups(nil, PickupVariant.COLLECTIBLE, collectibleType)
+end
+--- Helper function to get all of the heart pickup entities in the room.
+-- 
+-- @param heartSubType Optional. If specified, will only get the hearts that match the sub-type.
+-- Default is -1, which matches every sub-type.
+function ____exports.getHearts(self, heartSubType)
+    if heartSubType == nil then
+        heartSubType = -1
+    end
+    return getPickups(nil, PickupVariant.HEART, heartSubType)
+end
+--- Helper function to get all of the key pickup entities in the room.
+-- 
+-- @param keySubType Optional. If specified, will only get the keys that match the sub-type. Default
+-- is -1, which matches every sub-type.
+function ____exports.getKeys(self, keySubType)
+    if keySubType == nil then
+        keySubType = -1
+    end
+    return getPickups(nil, PickupVariant.KEY, keySubType)
+end
+--- Helper function to get all of the pill entities in the room.
+-- 
+-- @param pillColor Optional. If specified, will only get the pills that match the sub-type. Default
+-- is -1, which matches every sub-type.
+function ____exports.getPills(self, pillColor)
+    if pillColor == nil then
+        pillColor = -1
+    end
+    return getPickups(nil, PickupVariant.PILL, pillColor)
+end
+--- Helper function to get all of the sack (i.e. grab bag) entities in the room.
+-- 
+-- @param sackSubType Optional. If specified, will only get the sacks that match the sub-type.
+-- Default is -1, which matches every sub-type.
+function ____exports.getSacks(self, sackSubType)
+    if sackSubType == nil then
+        sackSubType = -1
+    end
+    return getPickups(nil, PickupVariant.SACK, sackSubType)
+end
+--- Helper function to get all of the trinket entities in the room.
+-- 
+-- @param trinketType Optional. If specified, will only get the trinkets that match the sub-type.
+-- Default is -1, which matches every sub-type.
+function ____exports.getTrinkets(self, trinketType)
+    if trinketType == nil then
+        trinketType = -1
+    end
+    return getPickups(nil, PickupVariant.TRINKET, trinketType)
+end
+--- Helper function to remove all of the batteries in the room.
+-- 
+-- @param batterySubType Optional. If specified, will only remove the batteries that match this
+-- sub-type. Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of cards.
+-- @returns The batteries that were removed.
+function ____exports.removeAllBatteries(self, batterySubType, cap)
+    if batterySubType == nil then
+        batterySubType = -1
+    end
+    return removeAllPickups(nil, PickupVariant.LIL_BATTERY, batterySubType, cap)
+end
+--- Helper function to remove all of the bomb pickups in the room. (Specifically, this refers to bomb
+-- pickups, not the `EntityBomb` class.)
+-- 
+-- @param bombSubType Optional. If specified, will only remove bombs that match this sub-type.
+-- Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of bombs.
+-- @returns The bombs that were removed.
+function ____exports.removeAllBombPickups(self, bombSubType, cap)
+    if bombSubType == nil then
+        bombSubType = -1
+    end
+    return removeAllPickups(nil, PickupVariant.BOMB, bombSubType, cap)
+end
+--- Helper function to remove all of the cards in the room.
+-- 
+-- @param cardType Optional. If specified, will only remove cards that match this sub-type. Default
+-- is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of cards.
+-- @returns The cards that were removed.
+function ____exports.removeAllCards(self, cardType, cap)
+    if cardType == nil then
+        cardType = -1
+    end
+    return removeAllPickups(nil, PickupVariant.CARD, cardType, cap)
+end
+--- Helper function to remove all of the coins in the room.
+-- 
+-- @param coinSubType Optional. If specified, will only remove coins that match this sub-type.
+-- Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of coins.
+-- @returns The coins that were removed.
+function ____exports.removeAllCoins(self, coinSubType, cap)
+    return removeAllPickups(nil, PickupVariant.COIN, coinSubType, cap)
+end
+--- Helper function to remove all of the collectibles in the room.
+-- 
+-- @param collectibleType Optional. If specified, will only remove collectibles that match this
+-- sub-type. Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of collectibles.
+-- @returns The collectibles that were removed.
+function ____exports.removeAllCollectibles(self, collectibleType, cap)
+    return removeAllPickups(nil, PickupVariant.COLLECTIBLE, collectibleType, cap)
+end
+--- Helper function to remove all of the heart pickup entities in the room.
+-- 
+-- @param heartSubType Optional. If specified, will only remove hearts that match this sub-type.
+-- Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of hearts.
+-- @returns The hearts that were removed.
+function ____exports.removeAllHearts(self, heartSubType, cap)
+    return removeAllPickups(nil, PickupVariant.HEART, heartSubType, cap)
+end
+--- Helper function to remove all of the keys in the room.
+-- 
+-- @param keySubType Optional. If specified, will only remove keys that match this sub-type. Default
+-- is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of keys.
+-- @returns The keys that were removed.
+function ____exports.removeAllKeys(self, keySubType, cap)
+    return removeAllPickups(nil, PickupVariant.KEY, keySubType, cap)
+end
+--- Helper function to remove all of the pills in the room.
+-- 
+-- @param pillColor Optional. If specified, will only remove pills that match this sub-type. Default
+-- is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of pills.
+-- @returns The pills that were removed.
+function ____exports.removeAllPills(self, pillColor, cap)
+    return removeAllPickups(nil, PickupVariant.PILL, pillColor, cap)
+end
+--- Helper function to remove all of the sacks (i.e. grab bags) in the room.
+-- 
+-- @param sackSubType Optional. If specified, will only remove sacks that match this sub-type.
+-- Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of sacks.
+-- @returns The sacks that were removed.
+function ____exports.removeAllSacks(self, sackSubType, cap)
+    return removeAllPickups(nil, PickupVariant.SACK, sackSubType, cap)
+end
+--- Helper function to remove all of the trinkets in the room.
+-- 
+-- @param trinketType Optional. If specified, will only remove trinkets that match this sub-type.
+-- Default is -1, which matches every sub-type.
+-- @param cap Optional. If specified, will only remove the given amount of trinkets.
+-- @returns The trinkets that were removed.
+function ____exports.removeAllTrinkets(self, trinketType, cap)
+    return removeAllPickups(nil, PickupVariant.TRINKET, trinketType, cap)
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
+function ____exports.spawnBattery(self, batterySubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.LIL_BATTERY,
+        batterySubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90)
+-- and a specific seed.
+function ____exports.spawnBatteryWithSeed(self, batterySubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnBattery(
+        nil,
+        batterySubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40).
+function ____exports.spawnBombPickup(self, bombSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.BOMB,
+        bombSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40) and a
+-- specific seed.
+function ____exports.spawnBombPickupWithSeed(self, bombSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnBombPickup(
+        nil,
+        bombSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.CARD` (300).
+function ____exports.spawnCard(self, cardType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.CARD,
+        cardType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.CARD` (300) and a
+-- specific seed.
+function ____exports.spawnCardWithSeed(self, cardType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnCard(
+        nil,
+        cardType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20).
+function ____exports.spawnCoin(self, coinSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.COIN,
+        coinSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20) and a
+-- specific seed.
+function ____exports.spawnCoinWithSeed(self, coinSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnCoin(
+        nil,
+        coinSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10).
+function ____exports.spawnHeart(self, heartSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.HEART,
+        heartSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+function ____exports.spawnHeartWithSeed(self, heartSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnHeart(
+        nil,
+        heartSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30).
+function ____exports.spawnKey(self, keySubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.KEY,
+        keySubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30) and a
+-- specific seed.
+function ____exports.spawnKeyWithSeed(self, keySubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnKey(
+        nil,
+        keySubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70).
+function ____exports.spawnPill(self, pillColor, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.PILL,
+        pillColor,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70) and a
+-- specific seed.
+function ____exports.spawnPillWithSeed(self, pillColor, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnPill(
+        nil,
+        pillColor,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69).
+function ____exports.spawnSack(self, sackSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.SACK,
+        sackSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69) and a
+-- specific seed.
+function ____exports.spawnSackWithSeed(self, sackSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnSack(
+        nil,
+        sackSubType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
+function ____exports.spawnTrinket(self, trinketType, positionOrGridIndex, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.TRINKET,
+        trinketType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350) and
+-- a specific seed.
+function ____exports.spawnTrinketWithSeed(self, trinketType, positionOrGridIndex, seedOrRNG, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    return ____exports.spawnTrinket(
+        nil,
+        trinketType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
+return ____exports

package/dist/functions/pills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pills.d.ts","sourceRoot":"","sources":["../../src/functions/pills.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACxB,UAAU,EACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAqCzD;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,EAAE,CAE9C;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAGxE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAEjE;AAED,4EAA4E;AAC5E,wBAAgB,kBAAkB,IAAI,SAAS,EAAE,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAM3E;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,IAAI,SAAS,EAAE,CAEjD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAGnE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAWxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,GACrB,yBAAyB,CAQ3B;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAgBhE;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,GACrB,wBAAwB,CAQ1B;AAED,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,wBAAwB,GACvC,SAAS,UAAU,EAAE,CAEvB;AAED,iGAAiG;AACjG,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAExD;AAED,sEAAsE;AACtE,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAEzD;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAElE;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAEnE"}