isaacscript-common 4.0.4 → 4.1.0

package/callbacks/postPlayerCollectible.lua

@@ -5,6 +5,7 @@ local __TS__Spread = ____lualib.__TS__Spread
 local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
 local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
 local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdate, collectibleCountChanged, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -48,7 +49,7 @@ function postPEffectUpdate(self, player)
     end
 end
 function collectibleCountChanged(self, player, numCollectiblesChanged, increased)
-    local oldCollectibleMap = defaultMapGetPlayer(nil, v.run.playersCollectibleMap, player, player)
+    local oldCollectibleMap = defaultMapGetPlayer(nil, v.run.playersCollectibleMap, player)
     local newCollectibleMap = getPlayerCollectibleMap(nil, player)
     mapSetPlayer(nil, v.run.playersCollectibleMap, player, newCollectibleMap)
     local ____array_0 = __TS__SparseArrayNew(__TS__Spread(oldCollectibleMap:keys()))
@@ -57,6 +58,7 @@ function collectibleCountChanged(self, player, numCollectiblesChanged, increased
         __TS__Spread(newCollectibleMap:keys())
     )
     local collectibleTypes = {__TS__SparseArraySpread(____array_0)}
+    __TS__ArraySort(collectibleTypes)
     local numFired = 0
     for ____, collectibleType in ipairs(collectibleTypes) do
         local oldNum = oldCollectibleMap:get(collectibleType) or 0
@@ -83,7 +85,7 @@ v = {run = {
     playersCollectibleCount = __TS__New(Map),
     playersCollectibleMap = __TS__New(
         DefaultMap,
-        function(____, player) return getPlayerCollectibleMap(nil, player) end
+        function() return __TS__New(Map) end
     )
 }}
 ---

package/functions/collectibleSet.d.ts

@@ -1,9 +1,44 @@
 import { CollectibleType } from "isaac-typescript-definitions";
+/**
+ * Returns an array containing every valid collectible type in the game, including modded
+ * collectibles.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getCollectibleArray` helper function instead.
+ */
+export declare function getCollectibleArray(): readonly CollectibleType[];
 /**
  * Returns a set containing every valid collectible type in the game, including modded collectibles.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getCollectibleArray` helper function instead.
  */
 export declare function getCollectibleSet(): ReadonlySet<CollectibleType>;
-/** Returns a set containing every modded collectible type in the game. */
+/**
+ * Returns an array containing every modded collectible type in the game.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getModdedCollectibleSet` helper function instead.
+ */
+export declare function getModdedCollectibleArray(): readonly CollectibleType[];
+/**
+ * Returns a set containing every modded collectible type in the game.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getModdedCollectibleArray` helper function instead.
+ */
 export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
-/** Returns a set containing every valid vanilla collectible type in the game. */
+/**
+ * Returns an array containing every valid vanilla collectible type in the game.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getVanillaCollectibleSet` helper function instead.
+ */
+export declare function getVanillaCollectibleArray(): readonly CollectibleType[];
+/**
+ * Returns a set containing every valid vanilla collectible type in the game.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getVanillaCollectibleArray` helper function instead.
+ */
 export declare function getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;

package/functions/collectibleSet.lua

@@ -1,6 +1,7 @@
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
@@ -8,45 +9,91 @@ local ____constantsFirstLast = require("constantsFirstLast")
 local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
 local ____collectibles = require("functions.collectibles")
 local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
+local ALL_COLLECTIBLES_ARRAY = {}
+local VANILLA_COLLECTIBLES_ARRAY = {}
+local MODDED_COLLECTIBLES_ARRAY = {}
 local ALL_COLLECTIBLES_SET = __TS__New(Set)
 local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
 local MODDED_COLLECTIBLES_SET = __TS__New(Set)
-local function initCollectibleSets(self)
+local function initCollectibleArraysAndSets(self)
+    if #ALL_COLLECTIBLES_ARRAY ~= 0 then
+        return
+    end
     for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
         do
             local itemConfigItem = itemConfig:GetCollectible(collectibleType)
             if itemConfigItem == nil then
-                goto __continue3
+                goto __continue4
             end
-            ALL_COLLECTIBLES_SET:add(collectibleType)
+            ALL_COLLECTIBLES_ARRAY[#ALL_COLLECTIBLES_ARRAY + 1] = collectibleType
             if collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE then
-                VANILLA_COLLECTIBLES_SET:add(collectibleType)
+                VANILLA_COLLECTIBLES_ARRAY[#VANILLA_COLLECTIBLES_ARRAY + 1] = collectibleType
             else
-                MODDED_COLLECTIBLES_SET:add(collectibleType)
+                MODDED_COLLECTIBLES_ARRAY[#MODDED_COLLECTIBLES_ARRAY + 1] = collectibleType
             end
         end
-        ::__continue3::
+        ::__continue4::
+    end
+    __TS__ArraySort(ALL_COLLECTIBLES_ARRAY)
+    __TS__ArraySort(VANILLA_COLLECTIBLES_ARRAY)
+    __TS__ArraySort(MODDED_COLLECTIBLES_ARRAY)
+    for ____, collectibleType in ipairs(ALL_COLLECTIBLES_ARRAY) do
+        ALL_COLLECTIBLES_SET:add(collectibleType)
+    end
+    for ____, collectibleType in ipairs(VANILLA_COLLECTIBLES_ARRAY) do
+        VANILLA_COLLECTIBLES_SET:add(collectibleType)
     end
+    for ____, collectibleType in ipairs(MODDED_COLLECTIBLES_ARRAY) do
+        MODDED_COLLECTIBLES_SET:add(collectibleType)
+    end
+end
+--- Returns an array containing every valid collectible type in the game, including modded
+-- collectibles.
+-- 
+-- Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+-- then use the `getCollectibleArray` helper function instead.
+function ____exports.getCollectibleArray(self)
+    initCollectibleArraysAndSets(nil)
+    return ALL_COLLECTIBLES_ARRAY
 end
 --- Returns a set containing every valid collectible type in the game, including modded collectibles.
+-- 
+-- Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+-- then use the `getCollectibleArray` helper function instead.
 function ____exports.getCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
+    initCollectibleArraysAndSets(nil)
     return ALL_COLLECTIBLES_SET
 end
+--- Returns an array containing every modded collectible type in the game.
+-- 
+-- Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+-- then use the `getModdedCollectibleSet` helper function instead.
+function ____exports.getModdedCollectibleArray(self)
+    initCollectibleArraysAndSets(nil)
+    return MODDED_COLLECTIBLES_ARRAY
+end
 --- Returns a set containing every modded collectible type in the game.
+-- 
+-- Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+-- then use the `getModdedCollectibleArray` helper function instead.
 function ____exports.getModdedCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
+    initCollectibleArraysAndSets(nil)
     return MODDED_COLLECTIBLES_SET
 end
+--- Returns an array containing every valid vanilla collectible type in the game.
+-- 
+-- Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+-- then use the `getVanillaCollectibleSet` helper function instead.
+function ____exports.getVanillaCollectibleArray(self)
+    initCollectibleArraysAndSets(nil)
+    return VANILLA_COLLECTIBLES_ARRAY
+end
 --- Returns a set containing every valid vanilla collectible type in the game.
+-- 
+-- Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+-- then use the `getVanillaCollectibleArray` helper function instead.
 function ____exports.getVanillaCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
+    initCollectibleArraysAndSets(nil)
     return VANILLA_COLLECTIBLES_SET
 end
 return ____exports

package/functions/enums.d.ts

@@ -55,6 +55,12 @@ export declare function getEnumLength<T>(transpiledEnum: T): int;
  * https://isaacscript.github.io/gotchas#iterating-over-enums
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
+/**
+ * Helper function to get the enum value with the highest value.
+ *
+ * Note that this is not necessarily the enum value that is declared last, since there is no way to
+ * infer that at run-time.
+ */
 export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
 /**
  * Helper function to get a random value from the provided enum.
@@ -66,8 +72,9 @@ export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
  */
 export declare function getRandomEnumValue<T>(transpiledEnum: T, seedOrRNG?: Seed | RNG, exceptions?: Array<T[keyof T]> | ReadonlyArray<T[keyof T]>): T[keyof T];
 /**
- * Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
- * because many methods of the Isaac class return -1 if they fail.
+ * Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
+ * -1 values are found. This is helpful because many methods of the Isaac class return -1 if they
+ * fail.
  *
  * For example:
  *
@@ -80,3 +87,9 @@ export declare function getRandomEnumValue<T>(transpiledEnum: T, seedOrRNG?: See
  * ```
  */
 export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: unknown): void;
+/**
+ * Helper function to validate if every value in an enum is contiguous, starting at 0.
+ *
+ * This is useful to automate checking large enums for typos.
+ */
+export declare function validateEnumContiguous<T>(transpiledEnumName: string, transpiledEnum: T): void;

package/functions/enums.lua

@@ -1,6 +1,8 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____array = require("functions.array")
 local getRandomArrayElement = ____array.getRandomArrayElement
@@ -8,6 +10,8 @@ local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
 local ____types = require("functions.types")
 local isString = ____types.isString
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 --- 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. Use this helper function to get the entries of the enum with the reverse
@@ -101,6 +105,10 @@ function ____exports.getEnumValues(self, transpiledEnum)
         end
     )
 end
+--- Helper function to get the enum value with the highest value.
+-- 
+-- Note that this is not necessarily the enum value that is declared last, since there is no way to
+-- infer that at run-time.
 function ____exports.getLastEnumValue(self, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
     local lastElement = enumValues[#enumValues]
@@ -125,8 +133,9 @@ function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, excepti
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
     return getRandomArrayElement(nil, enumValues, seedOrRNG, exceptions)
 end
---- Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
--- because many methods of the Isaac class return -1 if they fail.
+--- Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
+-- -1 values are found. This is helpful because many methods of the Isaac class return -1 if they
+-- fail.
 -- 
 -- For example:
 -- 
@@ -142,7 +151,26 @@ function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum
         local key = ____value[1]
         local value = ____value[2]
         if value == -1 then
-            error((("Failed to find custom enum value: " .. transpiledEnumName) .. ".") .. key)
+            error((("Failed to find the custom enum value: " .. transpiledEnumName) .. ".") .. key)
+        end
+    end
+end
+--- Helper function to validate if every value in an enum is contiguous, starting at 0.
+-- 
+-- This is useful to automate checking large enums for typos.
+function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)
+    local values = ____exports.getEnumValues(nil, transpiledEnum)
+    local valuesSet = __TS__New(Set, values)
+    local lastValue = values[#values]
+    if lastValue == nil then
+        error("Failed to validate that an enum was contiguous, since the last value was undefined.")
+    end
+    if type(lastValue) ~= "number" then
+        error("Failed to validate that an enum was contiguous, since the last value was not a number.")
+    end
+    for ____, value in ipairs(irange(nil, lastValue)) do
+        if not valuesSet:has(value) then
+            error((("Failed to find a custom enum value of " .. tostring(value)) .. " for: ") .. transpiledEnumName)
         end
     end
 end

package/functions/player.lua

@@ -5,7 +5,6 @@ local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local Map = ____lualib.Map
-local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
@@ -39,7 +38,7 @@ local isVanillaCharacter = ____character.isVanillaCharacter
 local ____collectibles = require("functions.collectibles")
 local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
 local ____collectibleSet = require("functions.collectibleSet")
-local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local getCollectibleArray = ____collectibleSet.getCollectibleArray
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____playerIndex = require("functions.playerIndex")
@@ -404,9 +403,9 @@ end
 --- Iterates over every item in the game and returns a map containing the number of each item that
 -- the player has.
 function ____exports.getPlayerCollectibleMap(self, player)
-    local collectibleSet = getCollectibleSet(nil)
+    local collectibleArray = getCollectibleArray(nil)
     local collectibleMap = __TS__New(Map)
-    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
+    for ____, collectibleType in ipairs(collectibleArray) do
         local collectibleNum = player:GetCollectibleNum(collectibleType, true)
         if collectibleNum > 0 then
             collectibleMap:set(collectibleType, collectibleNum)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.6"
+    "isaac-typescript-definitions": "^3.0.7"
   }
 }