isaacscript-common 1.0.494 → 1.0.498

package/dist/constants.d.ts

@@ -9,14 +9,28 @@ export declare const BOMB_EXPLODE_FRAME = 45;
 export declare const CHARACTERS_WITH_AN_ACTIVE_ITEM: Set<PlayerType>;
 /**
  * The set of characters where red heart containers will be turned into soul hearts (e.g. Blue
- * Baby). This set includes The Lost and Tainted Lost.
+ * Baby). This includes The Lost and Tainted Lost. This does not include Keeper or Tainted Keeper.
  */
 export declare const CHARACTERS_WITH_NO_RED_HEARTS: Set<PlayerType>;
 /**
  * The set of characters where soul hearts will be automatically stripped away (e.g. Bethany). This
- * set includes The Lost and Tainted Lost.
+ * includes The Lost and Tainted Lost.
  */
 export declare const CHARACTERS_WITH_NO_SOUL_HEARTS: Set<PlayerType>;
+/**
+ * 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.
+ */
+export declare const COLORS: {
+    BLACK: Color;
+    RED: Color;
+    GREEN: Color;
+    BLUE: Color;
+    YELLOW: Color;
+    PINK: Color;
+    CYAN: Color;
+    WHITE: Color;
+};
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.POOL_TREASURE;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;
@@ -27,6 +41,8 @@ export declare const DOOR_HITBOX_DISTANCE = 11;
  * value.
  */
 export declare const EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
+/** As of Repentance, the final stage is floor 13 (which is the Home floor). */
+export declare const FINAL_STAGE: number;
 /**
  * The random items that appear when the player has TMTRAINER are generated on the fly as they are
  * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The

package/dist/constants.lua

@@ -26,11 +26,28 @@ ____exports.CHARACTERS_WITH_NO_RED_HEARTS = __TS__New(Set, {
     PlayerType.PLAYER_THEFORGOTTEN_B,
     PlayerType.PLAYER_BETHANY_B
 })
-____exports.CHARACTERS_WITH_NO_SOUL_HEARTS = __TS__New(Set, {PlayerType.PLAYER_THELOST, PlayerType.PLAYER_BETHANY, PlayerType.PLAYER_THELOST_B})
+____exports.CHARACTERS_WITH_NO_SOUL_HEARTS = __TS__New(Set, {
+    PlayerType.PLAYER_THELOST,
+    PlayerType.PLAYER_KEEPER,
+    PlayerType.PLAYER_BETHANY,
+    PlayerType.PLAYER_THELOST_B,
+    PlayerType.PLAYER_KEEPER_B
+})
+____exports.COLORS = {
+    BLACK = Color(1, 1, 1),
+    RED = Color(1, 0, 0),
+    GREEN = Color(0, 1, 0),
+    BLUE = Color(0, 0, 1),
+    YELLOW = Color(1, 1, 0),
+    PINK = Color(1, 0, 1),
+    CYAN = Color(0, 1, 1),
+    WHITE = Color(1, 1, 1)
+}
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.POOL_TREASURE
 ____exports.DISTANCE_OF_GRID_TILE = 40
 ____exports.DOOR_HITBOX_DISTANCE = 11
 ____exports.EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45
+____exports.FINAL_STAGE = LevelStage.NUM_STAGES - 1
 ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
 ____exports.GENESIS_ROOM_VARIANT = 1000
 ____exports.GENESIS_ROOM_SUBTYPE = 99

package/dist/functions/collectibles.d.ts

@@ -56,6 +56,12 @@ export declare function isGlitchedCollectible(entity: Entity): boolean;
  */
 export declare function isPassiveCollectible(collectibleType: CollectibleType | int): boolean;
 export declare function isQuestCollectible(collectibleType: CollectibleType | int): boolean;
+/**
+ * Helper function to see if a particular collectible will disappear from the player's inventory
+ * upon use. Note that this will not work will modded items, as there is no way to dynamically know
+ * if a modded item will disappear.
+ */
+export declare function isSingleUseCollectible(collectibleType: CollectibleType | int): boolean;
 /**
  * Helper function to remove all of the collectibles in the room.
  *

package/dist/functions/collectibles.lua

@@ -2,6 +2,8 @@
 require("lualib_bundle");
 local ____exports = {}
 local COLLECTIBLE_SPRITE_LAYER
+local ____constants = require("constants")
+local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES = ____constants.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES
 local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local ____collectibleNameMap = require("maps.collectibleNameMap")
@@ -136,6 +138,9 @@ end
 function ____exports.isQuestCollectible(self, collectibleType)
     return ____exports.collectibleHasTag(nil, collectibleType, 32768)
 end
+function ____exports.isSingleUseCollectible(self, collectibleType)
+    return SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES:has(collectibleType)
+end
 function ____exports.removeAllCollectibles(self, collectibleType, cap)
     removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
 end

package/dist/functions/player.d.ts

@@ -22,8 +22,9 @@ export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boo
 export declare function anyPlayerIs(matchingCharacter: PlayerType): boolean;
 /**
  * Helper function to see if the provided character can have red heart containers. Returns true for
- * characters like Isaac, Magdalene, or Cain. Returns false for characters like Blue Baby. Returns
- * false for The Lost and Tainted Lost.
+ * characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
+ * though coin containers are not technically the same as red heart containers. Returns false for
+ * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
  */
 export declare function characterCanHaveRedHearts(character: PlayerType): boolean;
 /**

package/dist/functions/rooms.d.ts

@@ -24,9 +24,9 @@ export declare function getRoomData(): RoomConfig | undefined;
 export declare function getRoomDataType(): int;
 /**
  * Helper function to get the room index of the current room. Use this instead of calling
- * `Game().GetLevel().GetCurrentRoomIndex()` directly to avoid bugs with big rooms.
- * (Big rooms will return the specific 1x1 quadrant that the player entered the room at,
- * which can break data structures that use the room index as an index.)
+ * `Level.GetCurrentRoomIndex()` directly to avoid bugs with big rooms. (Big rooms will return the
+ * specific 1x1 quadrant that the player entered the room at, which can break data structures that
+ * use the room index as an index.)
  */
 export declare function getRoomIndex(): int;
 /**

package/dist/functions/rooms.lua

@@ -23,10 +23,6 @@ local hasFlag = ____flag.hasFlag
 function ____exports.getRoomIndex(self)
     local game = Game()
     local level = game:GetLevel()
-    local roomIndex = level:GetCurrentRoomIndex()
-    if roomIndex < 0 then
-        return roomIndex
-    end
     local roomDesc = level:GetCurrentRoomDesc()
     return roomDesc.SafeGridIndex
 end
@@ -223,14 +219,14 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue39
+                goto __continue38
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue39::
+        ::__continue38::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.494",
+  "version": "1.0.498",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.285",
+    "isaac-typescript-definitions": "^1.0.286",
     "isaacscript-lint": "^1.0.68",
     "typedoc": "^0.22.10",
     "typescript": "4.5.2",