isaacscript-common 1.2.120 → 1.2.123

package/dist/features/deployJSONRoom.d.ts

@@ -22,7 +22,7 @@ import { JSONRoom } from "../types/JSONRoom";
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
  */
-export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: number, verbose?: boolean): int;
+export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: Seed, verbose?: boolean): Seed;
 /**
  * Helper function to deconstruct a vanilla room and set up a custom room in its place.
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
@@ -50,7 +50,7 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: number, verbos
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
  */
-export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seed?: number, verbose?: boolean): int;
+export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seed?: Seed, verbose?: boolean): Seed;
 /**
  * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
  * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8),

package/dist/functions/array.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/// <reference types="typescript-to-lua/language-extensions" />
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
@@ -39,13 +38,13 @@ export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], pare
  *
  * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
  */
-export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seed?: number): T[];
+export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seed?: Seed): T[];
 /**
  * Shuffles the provided array in-place using the Fisher-Yates algorithm.
  *
  * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
  */
-export declare function shuffleArrayInPlace<T>(array: T[], seed?: number): void;
+export declare function shuffleArrayInPlace<T>(array: T[], seed?: Seed): void;
 export declare function sumArray(array: number[] | readonly number[]): number;
 export declare function arrayToString<T>(array: T[]): string;
 /**
@@ -70,7 +69,7 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T
  * @param seed Optional. The seed used to select the random element. Default is `Random()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed?: number, exceptions?: T[] | readonly T[]): T;
+export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed?: Seed, exceptions?: T[] | readonly T[]): T;
 /**
  * Helper function to get a random element from the provided array. Once the random element is
  * decided, it is then removed from the array (in-place).
@@ -79,8 +78,8 @@ export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed
  * @param seed Optional. The seed used to select the random element. Default is `Random()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: number, exceptions?: T[] | readonly T[]): T;
-export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?: number): int;
+export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: Seed, exceptions?: T[] | readonly T[]): T;
+export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?: Seed): int;
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
  * particular table is being used as an array. isArray returns true if:
@@ -88,4 +87,4 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?:
  * - the table contains all numerical indexes that are contiguous, starting at 1
  * - the table has no keys (i.e. an "empty" table)
  */
-export declare function isArray(table: LuaTable): boolean;
+export declare function isArray(thing: unknown): boolean;

package/dist/functions/array.lua

@@ -155,6 +155,9 @@ function ____exports.getRandomArrayElement(self, array, seed, exceptions)
     if exceptions == nil then
         exceptions = {}
     end
+    if #array == 0 then
+        error("Failed to get a random array element since the provided array is empty.")
+    end
     local arrayWithoutExceptions = ____exports.arrayRemove(
         nil,
         array,
@@ -174,22 +177,29 @@ function ____exports.getRandomArrayElementAndRemove(self, array, seed, exception
     ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
     return randomArrayElement
 end
-function ____exports.isArray(self, ____table)
-    local metatable = getmetatable(____table)
+function ____exports.isArray(self, thing)
+    if type(thing) ~= "table" then
+        return false
+    end
+    local thingTable = thing
+    local metatable = getmetatable(thingTable)
     if metatable ~= nil then
         return false
     end
     local numEntries = 0
-    for key in pairs(____table) do
+    for key in pairs(thingTable) do
         numEntries = numEntries + 1
         if type(key) ~= "number" then
             return false
         end
     end
+    if numEntries == 0 then
+        return true
+    end
     do
         local i = 1
         while i <= numEntries do
-            local element = ____table[i]
+            local element = thingTable[i]
             if element == nil then
                 return false
             end

package/dist/functions/cards.d.ts

@@ -40,13 +40,13 @@ export declare function getMaxCards(): int;
  * @param seed Optional. The seed with which to select the random card. Default is `Random()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCard(seed?: number, exceptions?: Card[]): Card;
+export declare function getRandomCard(seed?: Seed, exceptions?: Card[]): Card;
 /**
  * @param cardType The card type that represents the pool of cards to select from.
  * @param seed Optional. The seed with which to select the random card. Default is `Random()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCardOfType(cardType: CardType, seed?: number, exceptions?: Card[]): Card;
+export declare function getRandomCardOfType(cardType: CardType, seed?: Seed, exceptions?: Card[]): Card;
 /**
  * Has an equal chance of returning any rune (e.g. Rune of Hagalaz, Blank Rune, Black Rune, Soul of
  * Isaac, etc.). This will never return a Rune Shard.
@@ -54,7 +54,7 @@ export declare function getRandomCardOfType(cardType: CardType, seed?: number, e
  * @param seed Optional. The seed with which to select the random rune. Default is `Random()`.
  * @param exceptions Optional. An array of runes to not select.
  */
-export declare function getRandomRune(seed?: number, exceptions?: Card[]): Card;
+export declare function getRandomRune(seed?: Seed, exceptions?: Card[]): Card;
 /**
  * Returns true for cards that have the following card type:
  * - CardType.TAROT

package/dist/functions/jsonRoom.d.ts

@@ -9,4 +9,4 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[], subType: in
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  */
-export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seed?: number, verbose?: boolean): JSONRoom;
+export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seed?: Seed, verbose?: boolean): JSONRoom;

package/dist/functions/map.d.ts

@@ -1,2 +1,20 @@
+/// <reference types="isaac-typescript-definitions" />
+import { DefaultMap } from "../types/DefaultMap";
+import { PlayerIndex } from "../types/PlayerIndex";
 /** 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>;
+/**
+ * Helper function to make using default maps with an index of `PlayerIndex` easier. Use this
+ * instead of the `DefaultMap.getAndSetDefault` method.
+ */
+export declare function defaultMapGetPlayer<V>(map: DefaultMap<PlayerIndex, V>, player: EntityPlayer): V | undefined;
+/**
+ * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+ * `Map.get` method.
+ */
+export declare function mapGetPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): V | undefined;
+/**
+ * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+ * `Map.set` method.
+ */
+export declare function mapSetPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer, value: V): void;

package/dist/functions/map.lua

@@ -4,6 +4,8 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
+local ____player = require("functions.player")
+local getPlayerIndex = ____player.getPlayerIndex
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -13,4 +15,16 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
+function ____exports.defaultMapGetPlayer(self, map, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:getAndSetDefault(playerIndex)
+end
+function ____exports.mapGetPlayer(self, map, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:get(playerIndex)
+end
+function ____exports.mapSetPlayer(self, map, player, value)
+    local playerIndex = getPlayerIndex(nil, player)
+    map:set(playerIndex, value)
+end
 return ____exports

package/dist/functions/player.d.ts

@@ -250,6 +250,11 @@ export declare function isBethany(player: EntityPlayer): boolean;
  * (For example, the Strawman Keeper.)
  */
 export declare function isChildPlayer(player: EntityPlayer): boolean;
+/**
+ * Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
+ * you want to know if the starting stats were randomized, for example.
+ */
+export declare function isEden(player: EntityPlayer): boolean;
 export declare function isFirstPlayer(player: EntityPlayer): boolean;
 /**
  * Helper function for detecting when a player is Jacob or Esau. This will only match the

package/dist/functions/player.lua

@@ -543,6 +543,10 @@ function ____exports.isBethany(self, player)
     local character = player:GetPlayerType()
     return character == PlayerType.PLAYER_BETHANY or character == PlayerType.PLAYER_BETHANY_B
 end
+function ____exports.isEden(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.PLAYER_EDEN or character == PlayerType.PLAYER_EDEN_B
+end
 function ____exports.isFirstPlayer(self, player)
     return ____exports.getPlayerIndexVanilla(nil, player) == 0
 end
@@ -603,9 +607,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch128 = activeSlot
-        local ____cond128 = ____switch128 == ActiveSlot.SLOT_PRIMARY
-        if ____cond128 then
+        local ____switch129 = activeSlot
+        local ____cond129 = ____switch129 == ActiveSlot.SLOT_PRIMARY
+        if ____cond129 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -614,8 +618,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond128 = ____cond128 or ____switch128 == ActiveSlot.SLOT_SECONDARY
-        if ____cond128 then
+        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_SECONDARY
+        if ____cond129 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -630,16 +634,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond128 = ____cond128 or ____switch128 == ActiveSlot.SLOT_POCKET
-        if ____cond128 then
+        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_POCKET
+        if ____cond129 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond128 = ____cond128 or ____switch128 == ActiveSlot.SLOT_POCKET2
-        if ____cond128 then
+        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_POCKET2
+        if ____cond129 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/random.d.ts

@@ -4,7 +4,7 @@
  * the high end. (This is because `RNG.RandomFloat()` can return a value of 0.999, but it will never
  * return a value of exactly 1.)
  */
-export declare function getRandom(seed?: number): float;
+export declare function getRandom(seed?: Seed): float;
 /**
  * This returns a random float between min and max. It is inclusive on the low end, but exclusive on
  * the high end. (This is because `RNG.RandomFloat()` can return a value of 0.999, but it will never
@@ -15,7 +15,7 @@ export declare function getRandom(seed?: number): float;
  * const realNumberBetweenOneAndThree = getRandomFloat(1, 3, seed);
  * ```
  */
-export declare function getRandomFloat(min: int, max: int, seed?: number): float;
+export declare function getRandomFloat(min: int, max: int, seed?: Seed): float;
 /**
  * This returns a random integer between min and max, inclusive.
  *
@@ -24,14 +24,14 @@ export declare function getRandomFloat(min: int, max: int, seed?: number): float
  * const oneTwoOrThree = getRandomInt(1, 3, seed);
  * ```
  */
-export declare function getRandomInt(min: int, max: int, seed?: number): int;
+export declare function getRandomInt(min: int, max: int, seed?: Seed): int;
 /**
  * Helper function to get the next seed value.
  *
  * This function is useful because it is standard practice to work with seed values directly over
  * RNG objects, since the latter are not serializable.
  */
-export declare function nextSeed(seed: int): int;
+export declare function nextSeed(seed: Seed): Seed;
 /**
  * Helper function to initialize an RNG object.
  *
@@ -46,4 +46,4 @@ export declare function nextSeed(seed: int): int;
  * (If you aren't initializing it with a seed, then don't use this function and instead simply call
  * the `RNG()` constructor.)
  */
-export declare function initRNG(seed?: number): RNG;
+export declare function initRNG(seed?: Seed): RNG;

package/dist/functions/set.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
  * modified in place.
@@ -27,7 +28,7 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  * @param seed Optional. The seed used to select the random element. Default is `Random()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seed?: number, exceptions?: T[] | readonly T[]): T;
+export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seed?: Seed, exceptions?: T[] | readonly T[]): T;
 /**
  * Helper function to get a sorted array based on the contents of a set.
  *

package/dist/functions/spawnCollectible.d.ts

@@ -12,7 +12,7 @@
  * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
  * Tainted Keeper. Default is false.
  */
-export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seed?: number, options?: boolean, forceFreeItem?: boolean): EntityPickup;
+export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seed?: Seed, options?: boolean, forceFreeItem?: boolean): EntityPickup;
 /**
  * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
  * with `CollectibleType.COLLECTIBLE_NULL` will result in spawning a collectible with a random type
@@ -21,4 +21,4 @@ export declare function spawnCollectible(collectibleType: CollectibleType | int,
  * Instead, this function arbitrarily spawns a collectible with
  * `CollectibleType.COLLECTIBLE_SAD_ONION`, and then converts it to an empty pedestal afterward.
  */
-export declare function spawnEmptyCollectible(position: Vector, seed?: number): EntityPickup;
+export declare function spawnEmptyCollectible(position: Vector, seed?: Seed): EntityPickup;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.120",
+  "version": "1.2.123",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.2",
-    "isaac-typescript-definitions": "^1.0.359",
+    "isaac-typescript-definitions": "^1.0.360",
     "isaacscript-lint": "^1.0.84",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",