isaacscript-common 1.2.197 → 1.2.198

package/dist/features/characterStats.lua

@@ -7,8 +7,8 @@ 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
+local ____player = require("functions.player")
+local addStat = ____player.addStat
 function evaluateCache(self, player, cacheFlag)
     local character = player:GetPlayerType()
     local statMap = charactersStatMap:get(character)
@@ -21,49 +21,7 @@ function evaluateCache(self, player, cacheFlag)
         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
+    addStat(nil, player, cacheFlag, delta)
 end
 local FEATURE_NAME = "character stat manager"
 charactersStatMap = __TS__New(Map)

package/dist/features/deployJSONRoom.d.ts

@@ -8,7 +8,7 @@ import { JSONRoom } from "../types/JSONRoom";
  * This function is meant to be used in the PostNewRoom callback.
  *
  * @param jsonRoom The JSON room to deploy. In practice, this will be something like:
- * ```
+ * ```ts
  * import customRooms from "./customRooms";
  *
  * const firstJSONRoom = customRooms.rooms.room[0];
@@ -36,7 +36,7 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: Seed, verbose?
  *
  * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
  * something like:
- * ```
+ * ```ts
  * import customRooms from "./customRooms";
  *
  * const jsonRooms = customRooms.rooms.room;

package/dist/features/saveDataManager/exports.d.ts

@@ -9,7 +9,7 @@ import { SaveData } from "../../types/private/SaveData";
  * variables that are properly scoped.
  *
  * Example:
- * ```
+ * ```ts
  * // in file: feature1.ts
  * import { saveDataManager } from "isaacscript-common";
  *

package/dist/functions/array.d.ts

@@ -61,7 +61,7 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?:
  * Initializes an array with all elements containing the specified default value.
  *
  * Example:
- * ```
+ * ```ts
  * const playerTransformations = initArray(false, PlayerForm.NUM_PLAYER_FORMS - 1);
  * ```
  */

package/dist/functions/cards.d.ts

@@ -4,7 +4,7 @@ import { CardType } from "../enums/CardType";
  * Helper function to get a card description from a Card enum value.
  *
  * Example:
- * ```
+ * ```ts
  * const card = Card.CARD_FOOL;
  * const cardDescription = getCardDescription(card); // cardDescription is "Where journey begins"
  * ```
@@ -14,7 +14,7 @@ export declare function getCardDescription(card: Card | int): string;
  * Helper function to get a card name from a Card.
  *
  * Example:
- * ```
+ * ```ts
  * const card = Card.CARD_FOOL;
  * const cardName = getCardName(card); // cardName is "0 - The Fool"
  * ```

package/dist/functions/collectibles.d.ts

@@ -76,7 +76,7 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  * type is not valid.
  *
  * Example:
- * ```
+ * ```ts
  * const collectibleType = CollectibleType.COLLECTIBLE_SAD_ONION;
  * const collectibleName = getCollectibleName(collectibleType); // collectibleName is "Sad Onion"
  * ```

package/dist/functions/entity.d.ts

@@ -32,7 +32,7 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  * will be used instead.)
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the entities in the room invisible
  * for (const entity of getEntities()) {
  *   entity.Visible = false;

package/dist/functions/entitySpecific.d.ts

@@ -3,7 +3,7 @@
  * Helper function to get all of the bombs in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the bombs in the room invisible
  * for (const bomb of getBombs()) {
  *   bomb.Visible = false;
@@ -15,7 +15,7 @@ export declare function getBombs(matchingVariant?: BombVariant | int, matchingSu
  * Helper function to get all of the effects in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the effects in the room invisible
  * for (const effect of getEffects()) {
  *   effect.Visible = false;
@@ -27,7 +27,7 @@ export declare function getEffects(matchingVariant?: EffectVariant | int, matchi
  * Helper function to get all of the knives in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the knives in the room invisible
  * for (const knife of getKnives()) {
  *   knife.Visible = false;
@@ -39,7 +39,7 @@ export declare function getKnives(matchingVariant?: KnifeVariant | int, matching
  * Helper function to get all of the lasers in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the lasers in the room invisible
  * for (const laser of getLasers()) {
  *   laser.Visible = false;
@@ -51,7 +51,7 @@ export declare function getLasers(matchingVariant?: LaserVariant | int, matching
  * Helper function to get all of the projectiles in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the projectiles in the room invisible
  * for (const projectile of getProjectiles()) {
  *   projectile.Visible = false;
@@ -63,7 +63,7 @@ export declare function getProjectiles(matchingVariant?: ProjectileVariant | int
  * Helper function to get all of the slots in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the slots in the room invisible
  * for (const slot of getSlots()) {
  *   slot.Visible = false;
@@ -75,7 +75,7 @@ export declare function getSlots(matchingVariant?: SlotVariant | int, matchingSu
  * Helper function to get all of the tears in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the tears in the room invisible
  * for (const tear of getTears()) {
  *   tear.Visible = false;

package/dist/functions/familiars.d.ts

@@ -52,7 +52,7 @@ export declare function checkFamiliarFromCollectibles(player: EntityPlayer, coll
  * Helper function to get all of the familiars in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the familiars in the room invisible
  * for (const familiar of getFamiliars()) {
  *   familiar.Visible = false;

package/dist/functions/flag.d.ts

@@ -4,14 +4,14 @@
  * This is a variadic function, so pass as many flags as you want to add.
  *
  * Example 1:
- * ```
+ * ```ts
  * // Give the player spectral tears
  * const player = Isaac.GetPlayer();
  * player.TearFlags = addFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL);
  * ```
  *
  * Example 2:
- * ```
+ * ```ts
  * // Give the player spectral and homing tears
  * const player = Isaac.GetPlayer();
  * player.TearFlags = addFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL, TearFlags.TEAR_HOMING);
@@ -28,7 +28,7 @@ export declare function addFlag(flags: int, ...flag: int[]): int;
  * If passed multiple flags, it will only return true if all of the flags are set.
  *
  * Example:
- * ```
+ * ```ts
  * const player = Isaac.GetPlayer();
  * if (hasFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL) {
  *   // The player currently has spectral tears
@@ -50,7 +50,7 @@ export declare function isSelfDamage(damageFlags: int): boolean;
  * This is a variadic function, so pass as many flags as you want to remove.
  *
  * Example:
- * ```
+ * ```ts
  * // Remove spectral tears from the player, if present
  * const player = Isaac.GetPlayer();
  * player.TearFlags = removeFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL);

package/dist/functions/gridEntity.d.ts

@@ -20,14 +20,14 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
  * arguments to match specific grid entity types.
  *
  * Example:
- * ```
+ * ```ts
  * for (const gridEntity of getGridEntities()) {
  *   print(gridEntity.GetType())
  * }
  * ```
  *
  * Example:
- * ```
+ * ```ts
  * const rocks = getGridEntities(
  *   GridEntityType.GRID_ROCK,
  *   GridEntityType.GRID_ROCKB,
@@ -76,7 +76,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * provided.
  *
  * Example:
- * ```
+ * ```ts
  * removeAllGridEntitiesExceptFor(
  *   GridEntityType.GRID_WALL,
  *   GridEntityType.GRID_DOOR,
@@ -91,7 +91,7 @@ export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridE
  * provided.
  *
  * Example:
- * ```
+ * ```ts
  * removeAllMatchingGridEntities(
  *   GridEntityType.GRID_ROCK,
  *   GridEntityType.GRID_ROCKB,

package/dist/functions/pickups.d.ts

@@ -6,7 +6,7 @@ export declare function getKeys(matchingSubType?: number): EntityPickup[];
  * Helper function to get all of the pickups in the room.
  *
  * Example:
- * ```
+ * ```ts
  * // Make all of the pickups in the room invisible
  * for (const pickup of getPickups()) {
  *   pickup.Visible = false;

package/dist/functions/pills.d.ts

@@ -20,7 +20,7 @@ export declare function getPillEffectClass(pillEffect: PillEffect | int): PillEf
  * Helper function to get a pill effect name from a PillEffect enum value.
  *
  * Example:
- * ```
+ * ```ts
  * const pillEffect = PillEffect.PILLEFFECT_BAD_GAS;
  * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
  * ```

package/dist/functions/player.d.ts

@@ -1,6 +1,22 @@
 /// <reference types="isaac-typescript-definitions" />
 import { HealthType } from "../enums/HealthType";
 export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
+/**
+ * Helper function to add a stat to a player based on the `CacheFlag` provided. Call this function
+ * from the EvaluateCache callback.
+ *
+ * Note that for `CacheFlag.CACHE_FIREDELAY`, the "amount" argument will be interpreted as the tear
+ * stat to add (and not the amount to mutate `EntityPlayer.MaxFireDelay` by).
+ *
+ * This function supports the following cache flags:
+ * - CacheFlag.CACHE_DAMAGE (1 << 0)
+ * - CacheFlag.CACHE_FIREDELAY (1 << 1)
+ * - CacheFlag.CACHE_SHOTSPEED (1 << 2)
+ * - CacheFlag.CACHE_RANGE (1 << 3)
+ * - CacheFlag.CACHE_SPEED (1 << 4)
+ * - CacheFlag.CACHE_LUCK (1 << 10)
+ */
+export declare function addStat(player: EntityPlayer, cacheFlag: CacheFlag, amount: number): void;
 export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 export declare function anyPlayerHasCollectible(collectibleType: CollectibleType | int): boolean;
 export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boolean;

package/dist/functions/player.lua

@@ -1,7 +1,7 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArraySome = ____lualib.__TS__ArraySome
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
@@ -35,6 +35,8 @@ local getCollectibleSet = ____collectibleSet.getCollectibleSet
 local ____playerIndex = require("functions.playerIndex")
 local getPlayerIndexVanilla = ____playerIndex.getPlayerIndexVanilla
 local getPlayers = ____playerIndex.getPlayers
+local ____tears = require("functions.tears")
+local addTearsStat = ____tears.addTearsStat
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local getEnumValues = ____utils.getEnumValues
@@ -79,6 +81,14 @@ end
 function ____exports.isVanillaCharacter(self, player)
     return not ____exports.isModdedCharacter(nil, player)
 end
+local STAT_CACHE_FLAGS_SET = __TS__New(Set, {
+    CacheFlag.CACHE_DAMAGE,
+    CacheFlag.CACHE_FIREDELAY,
+    CacheFlag.CACHE_SHOTSPEED,
+    CacheFlag.CACHE_RANGE,
+    CacheFlag.CACHE_SPEED,
+    CacheFlag.CACHE_LUCK
+})
 function ____exports.addCollectibleCostume(self, player, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
@@ -86,6 +96,61 @@ function ____exports.addCollectibleCostume(self, player, collectibleType)
     end
     player:AddCostume(itemConfigItem, false)
 end
+function ____exports.addStat(self, player, cacheFlag, amount)
+    if not STAT_CACHE_FLAGS_SET:has(cacheFlag) then
+        error("You cannot add a stat to a player with the cache flag of: " .. tostring(cacheFlag))
+    end
+    repeat
+        local ____switch6 = cacheFlag
+        local ____cond6 = ____switch6 == CacheFlag.CACHE_DAMAGE
+        if ____cond6 then
+            do
+                player.Damage = player.Damage + amount
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_FIREDELAY
+        if ____cond6 then
+            do
+                addTearsStat(nil, player, amount)
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_SHOTSPEED
+        if ____cond6 then
+            do
+                player.ShotSpeed = player.ShotSpeed + amount
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_RANGE
+        if ____cond6 then
+            do
+                player.TearHeight = player.TearHeight + amount
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_SPEED
+        if ____cond6 then
+            do
+                player.MoveSpeed = player.MoveSpeed + amount
+                break
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == CacheFlag.CACHE_LUCK
+        if ____cond6 then
+            do
+                player.Luck = player.Luck + amount
+                break
+            end
+        end
+        do
+            do
+                break
+            end
+        end
+    until true
+end
 function ____exports.addTrinketCostume(self, player, trinketType)
     local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
     if itemConfigTrinket == nil then
@@ -413,9 +478,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch90 = activeSlot
-        local ____cond90 = ____switch90 == ActiveSlot.SLOT_PRIMARY
-        if ____cond90 then
+        local ____switch100 = activeSlot
+        local ____cond100 = ____switch100 == ActiveSlot.SLOT_PRIMARY
+        if ____cond100 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -424,8 +489,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond90 = ____cond90 or ____switch90 == ActiveSlot.SLOT_SECONDARY
-        if ____cond90 then
+        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_SECONDARY
+        if ____cond100 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -440,16 +505,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond90 = ____cond90 or ____switch90 == ActiveSlot.SLOT_POCKET
-        if ____cond90 then
+        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_POCKET
+        if ____cond100 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond90 = ____cond90 or ____switch90 == ActiveSlot.SLOT_POCKET2
-        if ____cond90 then
+        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_POCKET2
+        if ____cond100 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/random.d.ts

@@ -11,7 +11,7 @@ export declare function getRandom(seed?: Seed): float;
  * will never return a value of exactly 1.)
  *
  * Example:
- * ```
+ * ```ts
  * const realNumberBetweenOneAndThree = getRandomFloat(1, 3, seed);
  * ```
  */
@@ -20,7 +20,7 @@ export declare function getRandomFloat(min: int, max: int, seed?: Seed): float;
  * This returns a random integer between min and max, inclusive.
  *
  * Example:
- * ```
+ * ```ts
  * const oneTwoOrThree = getRandomInt(1, 3, seed);
  * ```
  */
@@ -29,7 +29,7 @@ export declare function getRandomInt(min: int, max: int, seed?: Seed): int;
  * Helper function to initialize an RNG object.
  *
  * Example:
- * ```
+ * ```ts
  * const startSeed = Game():GetSeeds():GetStartSeed();
  * const rng = initRNG(startSeed);
  * const fiftyFiftyChance = rng.RandomInt(2) === 0;

package/dist/functions/transformations.d.ts

@@ -6,7 +6,7 @@ export declare function getPlayerNumTransformationCollectibles(player: EntityPla
  * Helper function to get a transformation name from a PlayerForm enum.
  *
  * Example:
- * ```
+ * ```ts
  * const transformationName = getTransformationName(PlayerForm.PLAYERFORM_LORD_OF_THE_FLIES);
  * // transformationName is "Beelzebub"
  * ```

package/dist/functions/trinkets.d.ts

@@ -8,7 +8,7 @@ export declare function getMaxTrinketType(): int;
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
  * Example:
- * ```
+ * ```ts
  * const player = Isaac.GetPlayer();
  * const trinketSlot = getOpenTrinketSlotNum(player);
  * if (trinketSlot !== undefined) {
@@ -28,7 +28,7 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * not valid.
  *
  * Example:
- * ```
+ * ```ts
  * const trinketType = TrinketType.TRINKET_SWALLOWED_PENNY;
  * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
  * ```

package/dist/functions/utils.d.ts

@@ -2,34 +2,34 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 /**
  * Helper function to get type safety on a switch statement.
+ *
  * Very useful to be future-safe against people adding values to a type or an enum.
  *
  * Example:
- * ```
+ * ```ts
  * enum Situations {
- *   Situation1,
- *   Situation2,
- *   Situation3,
- *   // Situation4, // If we uncomment this line, the program will no longer compile
+ *   ONE,
+ *   TWO,
+ *   THREE,
+ *   // FOUR, // If we uncomment this line, the program will no longer compile
  * }
  *
  * function doThingBasedOnSituation(situation: Situation) {
  *   switch (situation) {
- *     case Situation1: {
+ *     case Situation.ONE: {
  *       return 41;
  *     }
  *
- *     case Situation2: {
+ *     case Situation.TWO: {
  *       return 68;
  *     }
  *
- *     case Situation3: {
+ *     case Situation.THREE: {
  *       return 12;
  *     }
  *
  *     default: {
- *       ensureAllCases(situation);
- *       return 0;
+ *       return ensureAllCases(situation);
  *     }
  *   }
  * }

package/dist/functions/utils.lua

@@ -3,7 +3,7 @@ local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__StringReplace = ____lualib.__TS__StringReplace
 local __TS__StringSubstr = ____lualib.__TS__StringSubstr
-local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
+local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local ____exports = {}
 local ____directionNames = require("objects.directionNames")
 local DIRECTION_NAMES = ____directionNames.DIRECTION_NAMES
@@ -83,9 +83,10 @@ function ____exports.validateCustomEnum(self, customEnumName, customEnum)
         return
     end
     local ____table = customEnum
-    for ____, ____value in ipairs(__TS__ObjectEntries(____table)) do
-        local key = ____value[1]
-        local value = ____value[2]
+    local keys = __TS__ObjectKeys(____table)
+    __TS__ArraySort(keys)
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
         if value == -1 then
             error((("Failed to find: " .. customEnumName) .. ".") .. key)
         end

package/dist/types/CollectibleIndex.d.ts

@@ -4,7 +4,7 @@
  * using this type.
  *
  * Example:
- * ```
+ * ```ts
  * const collectiblesNameMap = new Map<CollectibleIndex, string>();
  * ```
  *

package/dist/types/PlayerIndex.d.ts

@@ -4,7 +4,7 @@
  * function. Mods can signify that data structures handle `EntityPlayer` by using this type.
  *
  * Example:
- * ```
+ * ```ts
  * const playersNameMap = new Map<PlayerIndex, string>();
  * ```
  *

package/dist/upgradeMod.d.ts

@@ -4,7 +4,7 @@ import { ModUpgraded } from "./classes/ModUpgraded";
  * Use this function to enable the custom features and callbacks provided by `isaacscript-common`.
  *
  * Example:
- * ```
+ * ```ts
  * const modVanilla = RegisterMod("My Mod", 1);
  * const mod = upgradeMod(modVanilla);
  *

package/package.json

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