isaacscript-common 1.2.41 → 1.2.42

package/dist/callbacks/postPlayerChangeHealth.lua

@@ -8,9 +8,9 @@ local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____player = require("functions.player")
 local getPlayerIndex = ____player.getPlayerIndex
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
-local getEnumValues = ____util.getEnumValues
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+local getEnumValues = ____utils.getEnumValues
 local ____HealthType = require("types.HealthType")
 local HealthType = ____HealthType.HealthType
 local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
@@ -93,8 +93,7 @@ function getCurrentHealthValue(self, player, healthType)
         end
         do
             do
-                ensureAllCases(nil, healthType)
-                return 0
+                return ensureAllCases(nil, healthType)
             end
         end
     until true

package/dist/features/saveDataManager/main.lua

@@ -8,8 +8,8 @@ local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local SerializationType = ____deepCopy.SerializationType
-local ____util = require("functions.util")
-local tableClear = ____util.tableClear
+local ____table = require("functions.table")
+local tableClear = ____table.tableClear
 local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
 local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____SaveData = require("types.SaveData")

package/dist/features/saveDataManager/merge.lua

@@ -20,8 +20,8 @@ local isSerializedVector = ____deepCopy.isSerializedVector
 local SerializationType = ____deepCopy.SerializationType
 local ____log = require("functions.log")
 local log = ____log.log
-local ____util = require("functions.util")
-local tableClear = ____util.tableClear
+local ____table = require("functions.table")
+local tableClear = ____table.tableClear
 function ____exports.merge(self, oldObject, newTable, traversalDescription)
     local oldObjectType = type(oldObject)
     if oldObjectType ~= "table" then

package/dist/functions/collectibleCacheFlag.lua

@@ -11,8 +11,8 @@ local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
 local getMaxCollectibleID = ____collectibles.getMaxCollectibleID
 local ____set = require("functions.set")
 local copySet = ____set.copySet
-local ____util = require("functions.util")
-local getEnumValues = ____util.getEnumValues
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
 local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)
     local maxCollectibleID = getMaxCollectibleID(nil)

package/dist/functions/familiars.d.ts

@@ -2,8 +2,8 @@
 /**
  * Helper function to add and remove familiars based on a target amount that you specify. Use this
  * instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of the spawned familiar
- * will be set properly. Note that when using this function, you need to automatically account for
- * Box of Friends.
+ * will be set properly. Note that when using this function, you need to manually account for Box of
+ * Friends (by looking at the number of collectible effects on the player for Box of Friends).
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
@@ -27,7 +27,7 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
 /**
  * Helper function to add and remove familiars based on the amount of associated collectibles that a
  * player has. Use this instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of
- * the spawned familiar will be set properly and Box of Friends functions correctly.
+ * the spawned familiar will be set properly and Box of Friends is handled automatically.
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).

package/dist/functions/globals.lua

@@ -11,8 +11,8 @@ local log = ____log.log
 local ____set = require("functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local copySet = ____set.copySet
-local ____util = require("functions.util")
-local isLuaDebugEnabled = ____util.isLuaDebugEnabled
+local ____utils = require("functions.utils")
+local isLuaDebugEnabled = ____utils.isLuaDebugEnabled
 function twoDimensionalSort(self, a, b)
     if a[1] == b[1] then
         return 0

package/dist/functions/map.d.ts

@@ -0,0 +1,2 @@
+/** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
+export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;

package/dist/functions/map.lua

@@ -0,0 +1,16 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+function ____exports.copyMap(self, oldMap)
+    local newMap = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(oldMap:entries()) do
+        local key = ____value[1]
+        local value = ____value[2]
+        newMap:set(key, value)
+    end
+    return newMap
+end
+return ____exports

package/dist/functions/math.lua

@@ -3,8 +3,8 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local getCircleInitialPosition
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
 function getCircleInitialPosition(self, direction, radius)
     repeat
         local ____switch6 = direction
@@ -40,8 +40,7 @@ function getCircleInitialPosition(self, direction, radius)
         end
         do
             do
-                ensureAllCases(nil, direction)
-                return Vector.Zero
+                return ensureAllCases(nil, direction)
             end
         end
     until true

package/dist/functions/pickups.lua

@@ -5,8 +5,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____array = require("functions.array")
 local getRandomArrayElement = ____array.getRandomArrayElement
-local ____util = require("functions.util")
-local getEnumValues = ____util.getEnumValues
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
 function ____exports.getRandomHeartSubType(self, seed, exceptions)
     if seed == nil then
         seed = Random()

package/dist/functions/player.lua

@@ -29,10 +29,11 @@ local ____collectibles = require("functions.collectibles")
 local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
 local ____collectibleSet = require("functions.collectibleSet")
 local getCollectibleSet = ____collectibleSet.getCollectibleSet
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
-local stringContains = ____util.stringContains
-local trimPrefix = ____util.trimPrefix
+local ____string = require("functions.string")
+local stringContains = ____string.stringContains
+local trimPrefix = ____string.trimPrefix
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
 function ____exports.getCharacterMaxHeartContainers(self, character)
     if character == PlayerType.PLAYER_KEEPER then
         return 3

package/dist/functions/sound.lua

@@ -1,7 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____util = require("functions.util")
-local getEnumValues = ____util.getEnumValues
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
 function ____exports.stopAllSoundEffects(self)
     local sfxManager = SFXManager()
     for ____, soundEffect in ipairs(getEnumValues(nil, SoundEffect)) do

package/dist/functions/stage.lua

@@ -1,7 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
 function ____exports.isRepentanceStage(self, stageType)
     return stageType == StageType.STAGETYPE_REPENTANCE or stageType == StageType.STAGETYPE_REPENTANCE_B
 end
@@ -52,8 +52,7 @@ function ____exports.stageTypeToLetter(self, stageType)
         end
         do
             do
-                ensureAllCases(nil, stageType)
-                return ""
+                return ensureAllCases(nil, stageType)
             end
         end
     until true

package/dist/functions/string.d.ts

@@ -0,0 +1,5 @@
+export declare function stringContains(string: string, searchString: string): boolean;
+/** Helper function to trim a prefix from a string, if it exists. Returns the trimmed string. */
+export declare function trimPrefix(string: string, prefix: string): string;
+/** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
+export declare function trimSuffix(string: string, prefix: string): string;

package/dist/functions/string.lua

@@ -0,0 +1,23 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__StringSlice = ____lualib.__TS__StringSlice
+local __TS__StringEndsWith = ____lualib.__TS__StringEndsWith
+local ____exports = {}
+function ____exports.stringContains(self, ____string, searchString)
+    return (string.find(____string, searchString, nil, true) or 0) - 1 ~= -1
+end
+function ____exports.trimPrefix(self, ____string, prefix)
+    if not __TS__StringStartsWith(____string, prefix) then
+        return ____string
+    end
+    return __TS__StringSlice(____string, #prefix)
+end
+function ____exports.trimSuffix(self, ____string, prefix)
+    if not __TS__StringEndsWith(____string, prefix) then
+        return ____string
+    end
+    local endCharacter = #____string - #prefix
+    return __TS__StringSlice(____string, 0, endCharacter)
+end
+return ____exports

package/dist/functions/table.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
+ * `clear` method does not exist. Use this helper function as a drop-in replacement for this.
+ */
+export declare function tableClear(table: LuaTable): void;

package/dist/functions/table.lua

@@ -0,0 +1,8 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+function ____exports.tableClear(self, ____table)
+    for key in pairs(____table) do
+        ____table[key] = nil
+    end
+end
+return ____exports

package/dist/functions/trinketCacheFlag.lua

@@ -10,8 +10,8 @@ local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
 local getMaxTrinketID = ____trinkets.getMaxTrinketID
 local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
-local ____util = require("functions.util")
-local getEnumValues = ____util.getEnumValues
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
 local CACHE_FLAG_TO_TRINKETS_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)
     local maxTrinketID = getMaxTrinketID(nil)

package/dist/functions/utils.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * 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:
+ * ```
+ * enum Situations {
+ *   Situation1,
+ *   Situation2,
+ *   Situation3,
+ *   // Situation4, // If we uncomment this line, the program will no longer compile
+ * }
+ *
+ * function doThingBasedOnSituation(situation: Situation) {
+ *   switch (situation) {
+ *     case Situation1: {
+ *       return 41;
+ *     }
+ *
+ *     case Situation2: {
+ *       return 68;
+ *     }
+ *
+ *     case Situation3: {
+ *       return 12;
+ *     }
+ *
+ *     default: {
+ *       ensureAllCases(situation);
+ *       return 0;
+ *     }
+ *   }
+ * }
+ * ```
+ */
+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 values of an enum, use this helper function.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+export declare function getEnumValues(transpiledEnum: unknown): int[];
+/**
+ * Converts a hex string like "#33aa33" to a KColor object.
+ *
+ * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ */
+export declare function hexToKColor(hexString: string, alpha: float): KColor;
+/**
+ * Players can boot the game with an launch option called "--luadebug", which will enable additional
+ * functionality that is considered to be unsafe. For more information about this flag, see the
+ * wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+ *
+ * When this flag is enabled, the global environment will be slightly different. The differences are
+ * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+ *
+ * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+ * is enabled or not.
+ */
+export declare function isLuaDebugEnabled(): boolean;
+/**
+ * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
+ * pressing tab on the character selection screen). When the player resets the game on a set seed,
+ * the game will not switch to a different seed.
+ */
+export declare function onSetSeed(): boolean;
+/**
+ * Helper function to print something to the in-game console. Use this instead of invoking
+ * `Isaac.ConsoleOutput()` directly because it will automatically insert a newline at the end of the
+ * message (which `Isaac.ConsoleOutput()` does not do by default).
+ */
+export declare function printConsole(msg: string): void;

package/dist/functions/utils.lua

@@ -0,0 +1,56 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+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 ____exports = {}
+local HEX_STRING_LENGTH = 6
+____exports.ensureAllCases = function(____, obj) return obj end
+function ____exports.getEnumValues(self, transpiledEnum)
+    local enumValues = {}
+    for key, value in pairs(transpiledEnum) do
+        if type(key) == "string" then
+            __TS__ArrayPush(enumValues, value)
+        end
+    end
+    __TS__ArraySort(enumValues)
+    return enumValues
+end
+function ____exports.hexToKColor(self, hexString, alpha)
+    hexString = __TS__StringReplace(hexString, "#", "")
+    if #hexString ~= HEX_STRING_LENGTH then
+        error(("Hex strings must be of length " .. tostring(HEX_STRING_LENGTH)) .. ".")
+    end
+    local rString = __TS__StringSubstr(hexString, 0, 2)
+    local R = tonumber("0x" .. rString)
+    if R == nil then
+        error(("Failed to convert `0x" .. rString) .. "` to a number.")
+    end
+    local gString = __TS__StringSubstr(hexString, 2, 2)
+    local G = tonumber("0x" .. gString)
+    if G == nil then
+        error(("Failed to convert `0x" .. gString) .. "` to a number.")
+    end
+    local bString = __TS__StringSubstr(hexString, 4, 2)
+    local B = tonumber("0x" .. bString)
+    if B == nil then
+        error(("Failed to convert `0x" .. bString) .. "` to a number.")
+    end
+    local base = 255
+    return KColor(R / base, G / base, B / base, alpha)
+end
+function ____exports.isLuaDebugEnabled(self)
+    return package ~= nil
+end
+function ____exports.onSetSeed(self)
+    local game = Game()
+    local seeds = game:GetSeeds()
+    local customRun = seeds:IsCustomRun()
+    local challenge = Isaac.GetChallenge()
+    return challenge == Challenge.CHALLENGE_NULL and customRun
+end
+function ____exports.printConsole(self, msg)
+    Isaac.ConsoleOutput(msg .. "\n")
+end
+return ____exports

package/dist/functions/vector.lua

@@ -1,7 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
 function ____exports.copyVector(self, vector)
     return Vector(vector.X, vector.Y)
 end
@@ -40,8 +40,7 @@ function ____exports.directionToVector(self, direction)
         end
         do
             do
-                ensureAllCases(nil, direction)
-                return Vector.Zero
+                return ensureAllCases(nil, direction)
             end
         end
     until true

package/dist/index.d.ts

@@ -32,6 +32,7 @@ export * from "./functions/json";
 export * from "./functions/jsonRoom";
 export * from "./functions/language";
 export * from "./functions/log";
+export * from "./functions/map";
 export * from "./functions/math";
 export * from "./functions/npc";
 export * from "./functions/pickups";
@@ -49,6 +50,8 @@ export * from "./functions/sound";
 export * from "./functions/spawnCollectible";
 export * from "./functions/sprite";
 export * from "./functions/stage";
+export * from "./functions/string";
+export * from "./functions/table";
 export * from "./functions/tears";
 export * from "./functions/transformations";
 export * from "./functions/trinketCacheFlag";
@@ -56,7 +59,7 @@ export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
 export * from "./functions/trinketSet";
 export * from "./functions/ui";
-export * from "./functions/util";
+export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./maps/cardNameMap";
 export * from "./maps/collectibleNameMap";

package/dist/index.lua

@@ -266,6 +266,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.map")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.math")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -402,6 +410,22 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.string")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("functions.table")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.tears")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -459,7 +483,7 @@ do
     end
 end
 do
-    local ____export = require("functions.util")
+    local ____export = require("functions.utils")
     for ____exportKey, ____exportValue in pairs(____export) do
         if ____exportKey ~= "default" then
             ____exports[____exportKey] = ____exportValue

package/dist/patchErrorFunctions.lua

@@ -7,8 +7,8 @@ local ____exports = {}
 local errorWithTraceback, slimTracebackOutput, removeAnyLineThatContains, LINE_SEPARATOR, USELESS_TRACEBACK_MESSAGES, vanillaError
 local ____debug = require("functions.debug")
 local getTraceback = ____debug.getTraceback
-local ____util = require("functions.util")
-local isLuaDebugEnabled = ____util.isLuaDebugEnabled
+local ____utils = require("functions.utils")
+local isLuaDebugEnabled = ____utils.isLuaDebugEnabled
 function errorWithTraceback(message, level)
     if vanillaError == nil then
         error(message, level)

package/dist/types/ModUpgraded.lua

@@ -99,8 +99,8 @@ local ____preNewLevel = require("callbacks.subscriptions.preNewLevel")
 local preNewLevelRegister = ____preNewLevel.preNewLevelRegister
 local ____log = require("functions.log")
 local getDebugPrependString = ____log.getDebugPrependString
-local ____util = require("functions.util")
-local ensureAllCases = ____util.ensureAllCases
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
 local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
 local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 function getCallbackName(self, callbackID)
@@ -394,8 +394,7 @@ function getCallbackRegisterFunction(self, callbackID)
         end
         do
             do
-                ensureAllCases(nil, callbackID)
-                return error(("The custom callback ID of \"" .. tostring(callbackID)) .. "\" is not valid.")
+                return ensureAllCases(nil, callbackID)
             end
         end
     until true

package/package.json

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