isaacscript-common 1.2.190 → 1.2.193

package/dist/features/characterStats.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to manage the stats for a vanilla or custom character. Call this function once at
+ * the beginning of your mod to declare the starting stats.
+ *
+ * You must provide this function with a map of CacheFlag to the default stat amount. For example,
+ * the default amount of damage is 3.5. To make a custom character start with 4.5 damage:
+ *
+ * ```ts
+ * const fooDefaultStats = new Map<CacheFlag, number>([
+ *   [CacheFlag.CACHE_DAMAGE, 4.5],
+ * ])
+ * registerCharacterStats(PlayerTypeCustom.FOO, fooDefaultStats);
+ * ```
+ *
+ * Note that the format for the `CacheFlag.CACHE_FIREDELAY` value should be in the tears stat
+ * format, not the `MaxFireDelay` format.
+ */
+export declare function registerCharacterStats(playerType: PlayerType | int, statMap: Map<CacheFlag, number>): void;

package/dist/features/characterStats.lua

@@ -0,0 +1,77 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local evaluateCache, charactersStatMap
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____cacheFlag = require("functions.cacheFlag")
+local getDefaultPlayerStat = ____cacheFlag.getDefaultPlayerStat
+local ____tears = require("functions.tears")
+local addTearsStat = ____tears.addTearsStat
+function evaluateCache(self, player, cacheFlag)
+    local character = player:GetPlayerType()
+    local statMap = charactersStatMap:get(character)
+    if statMap == nil then
+        return
+    end
+    local stat = statMap:get(cacheFlag)
+    local defaultStat = getDefaultPlayerStat(nil, cacheFlag)
+    if stat == nil or defaultStat == nil then
+        return
+    end
+    local delta = stat - defaultStat
+    repeat
+        local ____switch6 = cacheFlag
+        local ____cond6 = ____switch6 == CacheFlag.CACHE_DAMAGE
+        if ____cond6 then
+            do
+                player.Damage = player.Damage + delta
+                return
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_FIREDELAY
+        if ____cond6 then
+            do
+                addTearsStat(nil, player, delta)
+                return
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_SHOTSPEED
+        if ____cond6 then
+            do
+                player.ShotSpeed = player.ShotSpeed + delta
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_RANGE
+        if ____cond6 then
+            do
+                player.TearHeight = player.TearHeight + delta
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_SPEED
+        if ____cond6 then
+            do
+                player.MoveSpeed = player.MoveSpeed + delta
+                break
+            end
+        end
+        do
+            do
+                break
+            end
+        end
+    until true
+end
+local FEATURE_NAME = "character stat manager"
+charactersStatMap = __TS__New(Map)
+function ____exports.characterStatsInit(self, mod)
+    mod:AddCallback(ModCallbacks.MC_EVALUATE_CACHE, evaluateCache)
+end
+function ____exports.registerCharacterStats(self, playerType, statMap)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    charactersStatMap:set(playerType, statMap)
+end
+return ____exports

package/dist/functions/cacheFlag.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Returns the starting stat that Isaac (the default character) starts with.
+ * Returns the starting stat that Isaac (the default character) starts with. For example, if you
+ * pass this function `CacheFlag.CACHE_DAMAGE`, it will return 3.5.
  *
- * For example, if you pass this function `CacheFlag.CACHE_DAMAGE`, it will return 3.5.
+ * Note that the default fire delay is represented in the tear stat, not the `MaxFireDelay` value.
  */
 export declare function getDefaultPlayerStat(cacheFlag: CacheFlag): number | undefined;

package/dist/functions/player.d.ts

@@ -46,6 +46,11 @@ export declare function characterCanHaveSoulHearts(character: PlayerType | int):
  * Otherwise, returns false.
  */
 export declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType | int): boolean;
+/**
+ * Helper function to find the active slot that the player has the corresponding collectible type
+ * in. Returns undefined if the player does not have the collectible in any active slot.
+ */
+export declare function getActiveItemSlot(player: EntityPlayer, collectibleType: CollectibleType | int): ActiveSlot | undefined;
 /**
  * Helper function to get every player with no restrictions, by using `Game.GetNumPlayers` and
  * `Isaac.GetPlayer`.

package/dist/functions/player.lua

@@ -2,9 +2,9 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
-local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
@@ -39,6 +39,7 @@ local ____collectibleSet = require("functions.collectibleSet")
 local getCollectibleSet = ____collectibleSet.getCollectibleSet
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
+local getEnumValues = ____utils.getEnumValues
 local ____repeat = ____utils["repeat"]
 function ____exports.getAllPlayers(self)
     local numPlayers = game:GetNumPlayers()
@@ -95,15 +96,15 @@ end
 function getPlayerIndexCollectibleType(self, player, differentiateForgottenAndSoul)
     local character = player:GetPlayerType()
     repeat
-        local ____switch71 = character
-        local ____cond71 = ____switch71 == PlayerType.PLAYER_THESOUL
-        if ____cond71 then
+        local ____switch73 = character
+        local ____cond73 = ____switch73 == PlayerType.PLAYER_THESOUL
+        if ____cond73 then
             do
                 return differentiateForgottenAndSoul and CollectibleType.COLLECTIBLE_SPOON_BENDER or DEFAULT_COLLECTIBLE_TYPE
             end
         end
-        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_LAZARUS2_B
-        if ____cond71 then
+        ____cond73 = ____cond73 or ____switch73 == PlayerType.PLAYER_LAZARUS2_B
+        if ____cond73 then
             do
                 return CollectibleType.COLLECTIBLE_INNER_EYE
             end
@@ -240,6 +241,16 @@ end
 function ____exports.characterGetsBlackHeartFromEternalHeart(self, character)
     return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART:has(character)
 end
+function ____exports.getActiveItemSlot(self, player, collectibleType)
+    local activeSlots = getEnumValues(nil, ActiveSlot)
+    return __TS__ArrayFind(
+        activeSlots,
+        function(____, activeSlot)
+            local activeItem = player:GetActiveItem(activeSlot)
+            return activeItem == collectibleType
+        end
+    )
+end
 function ____exports.getAzazelBrimstoneDistance(self, playerOrTearHeight)
     local tearHeight = tonumber(playerOrTearHeight)
     if tearHeight == nil then
@@ -563,9 +574,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch124 = activeSlot
-        local ____cond124 = ____switch124 == ActiveSlot.SLOT_PRIMARY
-        if ____cond124 then
+        local ____switch126 = activeSlot
+        local ____cond126 = ____switch126 == ActiveSlot.SLOT_PRIMARY
+        if ____cond126 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -574,8 +585,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_SECONDARY
-        if ____cond124 then
+        ____cond126 = ____cond126 or ____switch126 == ActiveSlot.SLOT_SECONDARY
+        if ____cond126 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -590,16 +601,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_POCKET
-        if ____cond124 then
+        ____cond126 = ____cond126 or ____switch126 == ActiveSlot.SLOT_POCKET
+        if ____cond126 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_POCKET2
-        if ____cond124 then
+        ____cond126 = ____cond126 or ____switch126 == ActiveSlot.SLOT_POCKET2
+        if ____cond126 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/utils.d.ts

@@ -36,6 +36,21 @@
  * ```
  */
 export declare const ensureAllCases: (obj: never) => never;
+/**
+ * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
+ * when you iterate over them, you will get both the names of the enums and the values of the enums,
+ * in a random order. If all you need are the keys of an enum, use this helper function.
+ *
+ * This function will return the enum keys in a sorted order, which may not necessarily be the same
+ * order as which they were declared in.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+export declare function getEnumKeys<T>(transpiledEnum: T): string[];
 /**
  * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
  * when you iterate over them, you will get both the names of the enums and the values of the enums,

package/dist/functions/utils.lua

@@ -6,6 +6,16 @@ local __TS__StringSubstr = ____lualib.__TS__StringSubstr
 local ____exports = {}
 local HEX_STRING_LENGTH = 6
 ____exports.ensureAllCases = function(____, obj) return obj end
+function ____exports.getEnumKeys(self, transpiledEnum)
+    local enumKeys = {}
+    for key in pairs(transpiledEnum) do
+        if type(key) == "string" then
+            __TS__ArrayPush(enumKeys, key)
+        end
+    end
+    __TS__ArraySort(enumKeys)
+    return enumKeys
+end
 function ____exports.getEnumValues(self, transpiledEnum)
     local enumValues = {}
     for key, value in pairs(transpiledEnum) do

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export * from "./enums/PillEffectClass";
 export * from "./enums/PillEffectType";
 export * from "./enums/PocketItemType";
 export * from "./enums/SerializationType";
+export * from "./features/characterStats";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
 export { disableAllSound, enableAllSound } from "./features/disableSound";

package/dist/index.lua

@@ -110,6 +110,14 @@ do
         end
     end
 end
+do
+    local ____export = require("features.characterStats")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____deployJSONRoom = require("features.deployJSONRoom")
     local deployJSONRoom = ____deployJSONRoom.deployJSONRoom

package/dist/maps/defaultPlayerStatMap.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="isaac-typescript-definitions" />
+/** The default fire delay is represented in the tear stat, not the `MaxFireDelay` value. */
 export declare const DEFAULT_PLAYER_STAT_MAP: ReadonlyMap<CacheFlag, number>;

package/dist/maps/defaultPlayerStatMap.lua

@@ -2,12 +2,21 @@ local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-____exports.DEFAULT_PLAYER_STAT_MAP = __TS__New(Map, {
-    {CacheFlag.CACHE_DAMAGE, 3.5},
-    {CacheFlag.CACHE_FIREDELAY, 10},
-    {CacheFlag.CACHE_SHOTSPEED, 1},
-    {CacheFlag.CACHE_RANGE, 6.5},
-    {CacheFlag.CACHE_SPEED, 1},
-    {CacheFlag.CACHE_LUCK, 0}
-})
+local ____tears = require("functions.tears")
+local getTearsStat = ____tears.getTearsStat
+local DEFAULT_MAX_FIRE_DELAY = 10
+____exports.DEFAULT_PLAYER_STAT_MAP = __TS__New(
+    Map,
+    {
+        {CacheFlag.CACHE_DAMAGE, 3.5},
+        {
+            CacheFlag.CACHE_FIREDELAY,
+            getTearsStat(nil, DEFAULT_MAX_FIRE_DELAY)
+        },
+        {CacheFlag.CACHE_SHOTSPEED, 1},
+        {CacheFlag.CACHE_RANGE, 6.5},
+        {CacheFlag.CACHE_SPEED, 1},
+        {CacheFlag.CACHE_LUCK, 0}
+    }
+)
 return ____exports

package/dist/upgradeMod.lua

@@ -78,6 +78,8 @@ local ____roomClearChange = require("callbacks.roomClearChange")
 local roomClearChangeCallbackInit = ____roomClearChange.roomClearChangeCallbackInit
 local ____ModUpgraded = require("classes.ModUpgraded")
 local ModUpgraded = ____ModUpgraded.ModUpgraded
+local ____characterStats = require("features.characterStats")
+local characterStatsInit = ____characterStats.characterStatsInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableInputs = require("features.disableInputs")
@@ -163,6 +165,7 @@ function initFeatures(self, mod)
     taintedLazarusPlayersInit(nil, mod)
     fastResetInit(nil, mod)
     fadeInRemoverInit(nil, mod)
+    characterStatsInit(nil, mod)
 end
 function ____exports.upgradeMod(self, modVanilla, verbose)
     if verbose == nil then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.190",
+  "version": "1.2.193",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,11 +25,11 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.372",
+    "isaac-typescript-definitions": "^1.0.373",
     "isaacscript-lint": "^1.0.93",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
     "typescript": "4.6.2",
-    "typescript-to-lua": "^1.4.1"
+    "typescript-to-lua": "^1.4.2"
   }
 }