isaacscript-common 1.2.39 → 1.2.40

package/dist/constants.d.ts

@@ -11,19 +11,19 @@ export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
 /** Bombs explode when their frame count is equal to this value. */
 export declare const BOMB_EXPLODE_FRAME = 45;
-export declare const CHARACTERS_WITH_AN_ACTIVE_ITEM: Set<PlayerType>;
-export declare const CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART: Set<PlayerType>;
-export declare const CHARACTERS_WITH_FREE_DEVIL_DEALS: Set<PlayerType>;
+export declare const CHARACTERS_WITH_AN_ACTIVE_ITEM: ReadonlySet<PlayerType>;
+export declare const CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART: ReadonlySet<PlayerType>;
+export declare const CHARACTERS_WITH_FREE_DEVIL_DEALS: ReadonlySet<PlayerType>;
 /**
  * The set of characters where red heart containers will be turned into soul hearts (e.g. Blue
  * Baby). This includes The Lost and Tainted Lost. This does not include Keeper or Tainted Keeper.
  */
-export declare const CHARACTERS_WITH_NO_RED_HEARTS: Set<PlayerType>;
+export declare const CHARACTERS_WITH_NO_RED_HEARTS: ReadonlySet<PlayerType>;
 /**
  * The set of characters where soul hearts will be automatically stripped away (e.g. Bethany). This
  * includes The Lost and Tainted Lost.
  */
-export declare const CHARACTERS_WITH_NO_SOUL_HEARTS: Set<PlayerType>;
+export declare const CHARACTERS_WITH_NO_SOUL_HEARTS: ReadonlySet<PlayerType>;
 /**
  * A collection of common colors that can be reused. Note that if you want to further modify these
  * colors, you should copy them first with the `copyColor` function.
@@ -53,7 +53,7 @@ export declare const EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
  * information, see the documentation for the `clearSprite()` helper function.
  */
 export declare const EMPTY_PNG_PATH = "gfx/none.png";
-export declare const FAMILIARS_THAT_SHOOT_PLAYER_TEARS: Set<FamiliarVariant>;
+export declare const FAMILIARS_THAT_SHOOT_PLAYER_TEARS: ReadonlySet<FamiliarVariant>;
 /** As of Repentance, the final stage is floor 13 (which is the Home floor). */
 export declare const FINAL_STAGE: number;
 /**
@@ -72,7 +72,7 @@ export declare const ISAAC_FRAMES_PER_SECOND = 60;
  * This is the set of characters that look like The Lost and play the "LostDeath" animation when
  * they die.
  */
-export declare const LOST_STYLE_PLAYER_TYPES: Set<PlayerType>;
+export declare const LOST_STYLE_PLAYER_TYPES: ReadonlySet<PlayerType>;
 /** In a 2x2 room, there can be 8 doors. */
 export declare const MAX_NUM_DOORS = 8;
 /**
@@ -104,13 +104,13 @@ export declare const MAX_VANILLA_CHARACTER = PlayerType.PLAYER_THESOUL_B;
 export declare const MAX_VANILLA_COLLECTIBLE_TYPE = CollectibleType.COLLECTIBLE_MOMS_RING;
 export declare const SECOND_IN_MILLISECONDS = 1000;
 export declare const MINUTE_IN_MILLISECONDS: number;
-export declare const MOVEMENT_ACTIONS: ButtonAction[];
-export declare const MOVEMENT_ACTIONS_SET: Set<ButtonAction>;
+export declare const MOVEMENT_ACTIONS: readonly ButtonAction[];
+export declare const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction>;
 export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
-export declare const SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES: Set<CollectibleType>;
-export declare const SHOOTING_ACTIONS: ButtonAction[];
-export declare const SHOOTING_ACTIONS_SET: Set<ButtonAction>;
-export declare const STORY_BOSSES: Set<EntityType>;
+export declare const SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES: ReadonlySet<CollectibleType>;
+export declare const SHOOTING_ACTIONS: readonly ButtonAction[];
+export declare const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction>;
+export declare const STORY_BOSSES: ReadonlySet<EntityType>;
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
  * corner.

package/dist/features/disableInputs.d.ts

@@ -22,7 +22,7 @@ export declare function disableAllInputs(): void;
  * Note that calling any of the various `enable` or `disable` functions will override the effects of
  * this function.
  */
-export declare function enableAllInputsExceptFor(blacklist: Set<ButtonAction>): void;
+export declare function enableAllInputsExceptFor(blacklist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
 /**
  * Helper function to disable all inputs besides the ones provided.
  * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain

package/dist/functions/array.d.ts

@@ -5,16 +5,16 @@
  * specified arrays. This function is variadic, meaning that you can specify N arguments to combine
  * N arrays. Note that this will only perform a shallow copy of the array elements.
  */
-export declare function arrayCombine<T>(...arrays: T[][]): T[];
+export declare function arrayCombine<T>(...arrays: Array<T[] | readonly T[]>): T[];
 /** Helper function to perform a shallow copy. */
-export declare function arrayCopy<T>(array: T[]): T[];
+export declare function arrayCopy<T>(array: T[] | readonly T[]): T[];
 export declare function arrayEmpty<T>(array: T[]): void;
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
  */
-export declare function arrayEquals<T>(array1: T[], array2: T[]): boolean;
-export declare function arrayInArray<T>(arrayToMatch: T[], parentArray: T[][]): boolean;
+export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] | readonly T[]): boolean;
+export declare function arrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
 /**
  * Initializes an array with all elements containing the specified default value.
  *
@@ -29,14 +29,14 @@ export declare function arrayInit<T>(defaultValue: T, size: int): T[];
  *
  * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
  */
-export declare function arrayShuffle<T>(originalArray: T[], seed?: number): T[];
+export declare function arrayShuffle<T>(originalArray: T[] | readonly T[], seed?: number): 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 arrayShuffleInPlace<T>(array: T[], seed?: number): void;
-export declare function arraySum(array: int[]): int;
+export declare function arraySum(array: number[] | readonly number[]): number;
 export declare function arrayToString<T>(array: T[]): string;
 /**
  * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
@@ -45,14 +45,14 @@ export declare function arrayToString<T>(array: T[]): string;
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-export declare function arrayRemove<T>(originalArray: T[], ...elements: T[]): T[];
+export declare function arrayRemove<T>(originalArray: T[] | readonly T[], ...elements: T[]): T[];
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
  * array, this function will do nothing. Returns whether or not one or more elements were removed.
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-export declare function arrayRemoveInPlace<T>(array: T[], ...elements: T[]): boolean;
+export declare function arrayRemoveInPlace<T>(array: T[], ...elements: T[] | readonly T[]): boolean;
 /**
  * Helper function to get a random element from the provided array.
  *
@@ -60,7 +60,7 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elements: T[]): boo
  * @param seed Optional. The seed used to select the random element. `Random()` by default.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElement<T>(array: T[], seed?: number, exceptions?: T[]): T;
+export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed?: number, 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).
@@ -69,8 +69,8 @@ export declare function getRandomArrayElement<T>(array: T[], seed?: number, exce
  * @param seed Optional. The seed used to select the random element. `Random()` by default.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: number, exceptions?: T[]): T;
-export declare function getRandomArrayIndex<T>(array: T[], seed?: number): int;
+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;
 /**
  * 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:

package/dist/functions/cards.lua

@@ -1,7 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local Set = ____lualib.Set
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____cardDescriptionMap = require("maps.cardDescriptionMap")

package/dist/functions/challenges.lua

@@ -1,6 +1,4 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
 local ____exports = {}
 local ____challengeNameMap = require("maps.challengeNameMap")
 local CHALLENGE_NAME_MAP = ____challengeNameMap.CHALLENGE_NAME_MAP

package/dist/functions/collectibles.lua

@@ -1,7 +1,4 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local Map = ____lualib.Map
 local ____exports = {}
 local COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
 local ____constants = require("constants")

package/dist/functions/entity.lua

@@ -1,8 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
+local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local Map = ____lualib.Map

package/dist/functions/familiars.lua

@@ -1,6 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}

package/dist/functions/flying.d.ts

@@ -14,6 +14,6 @@ export declare function getFlyingCollectibles(pruneConditionalItems: boolean): S
  * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
  * conditionally, like Bat Wing.)
  */
-export declare function getFlyingTrinkets(): Set<CollectibleType | int>;
+export declare function getFlyingTrinkets(): ReadonlySet<CollectibleType | int>;
 export declare function hasFlyingTemporaryEffect(player: EntityPlayer): boolean;
 export declare function isFlyingCharacter(player: EntityPlayer): boolean;

package/dist/functions/gridEntity.lua

@@ -1,6 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New

package/dist/functions/pills.lua

@@ -1,6 +1,4 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
 local ____exports = {}
 local ____pillEffectClassMap = require("maps.pillEffectClassMap")
 local PILL_EFFECT_CLASS_MAP = ____pillEffectClassMap.PILL_EFFECT_CLASS_MAP

package/dist/functions/set.d.ts

@@ -4,19 +4,19 @@
  *
  * This function is variadic, meaning that you can specify N sets to add to the first set.
  */
-export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T>>): void;
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T> | ReadonlySet<T>>): void;
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-export declare function copySet<T>(oldSet: Set<T>): Set<T>;
+export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
 /**
  * Helper function to create a new set that is the composition of two or more sets.
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-export declare function combineSets<T>(...sets: Array<Set<T>>): Set<T>;
+export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>): Set<T>;
 /**
  * Helper function to delete all of the values in one set from another set. The first set passed
  * will be modified in place.
  *
  * This function is variadic, meaning that you can specify N sets to remove from the first set.
  */
-export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: Array<Set<T>>): void;
+export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: Array<Set<T> | ReadonlySet<T>>): void;

package/dist/functions/trinkets.lua

@@ -1,6 +1,4 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
 local ____exports = {}
 local ____constants = require("constants")
 local GOLDEN_TRINKET_SHIFT = ____constants.GOLDEN_TRINKET_SHIFT

package/dist/maps/cardDescriptionMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const CARD_DESCRIPTION_MAP: Map<Card, string>;
+export declare const CARD_DESCRIPTION_MAP: ReadonlyMap<Card, string>;

package/dist/maps/cardNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const CARD_NAME_MAP: Map<Card, string>;
+export declare const CARD_NAME_MAP: ReadonlyMap<Card, string>;

package/dist/maps/challengeNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const CHALLENGE_NAME_MAP: Map<Challenge, string>;
+export declare const CHALLENGE_NAME_MAP: ReadonlyMap<Challenge, string>;

package/dist/maps/collectibleDescriptionMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const COLLECTIBLE_DESCRIPTION_MAP: Map<CollectibleType, string>;
+export declare const COLLECTIBLE_DESCRIPTION_MAP: ReadonlyMap<CollectibleType, string>;

package/dist/maps/collectibleNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const COLLECTIBLE_NAME_MAP: Map<CollectibleType, string>;
+export declare const COLLECTIBLE_NAME_MAP: ReadonlyMap<CollectibleType, string>;

package/dist/maps/gridEntityXMLMap.d.ts

@@ -3,4 +3,7 @@
  * This maps the GridEntityXMLType (i.e. the type contained in the room XML/STB file) to the
  * GridEntityType and the variant used by the game.
  */
-export declare const GRID_ENTITY_XML_MAP: Map<GridEntityXMLType, [GridEntityType, number]>;
+export declare const GRID_ENTITY_XML_MAP: ReadonlyMap<GridEntityXMLType, [
+    GridEntityType,
+    int
+]>;

package/dist/maps/pillEffectClassMap.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="isaac-typescript-definitions" />
 import { PillEffectClass } from "../types/PillEffectClass";
-export declare const PILL_EFFECT_CLASS_MAP: Map<PillEffect, PillEffectClass>;
+export declare const PILL_EFFECT_CLASS_MAP: ReadonlyMap<PillEffect, PillEffectClass>;

package/dist/maps/pillEffectNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const PILL_EFFECT_NAME_MAP: Map<PillEffect, string>;
+export declare const PILL_EFFECT_NAME_MAP: ReadonlyMap<PillEffect, string>;

package/dist/maps/pillEffectTypeMap.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="isaac-typescript-definitions" />
 import { PillEffectType } from "../types/PillEffectType";
-export declare const PILL_EFFECT_TYPE_MAP: Map<PillEffect, PillEffectType>;
+export declare const PILL_EFFECT_TYPE_MAP: ReadonlyMap<PillEffect, PillEffectType>;

package/dist/maps/roomShapeToTopLeftWallGridIndexMap.d.ts

@@ -3,5 +3,5 @@
  * Only used for special room shapes where the top left wall grid index is not equal to
  * `DEFAULT_TOP_LEFT_WALL_GRID_INDEX`.
  */
-export declare const ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP: Map<RoomShape, number>;
+export declare const ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP: ReadonlyMap<RoomShape, int>;
 export declare const DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0;

package/dist/maps/transformationNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const TRANSFORMATION_NAME_MAP: Map<PlayerForm, string>;
+export declare const TRANSFORMATION_NAME_MAP: ReadonlyMap<PlayerForm, string>;

package/dist/maps/trinketDescriptionMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const TRINKET_DESCRIPTION_MAP: Map<TrinketType, string>;
+export declare const TRINKET_DESCRIPTION_MAP: ReadonlyMap<TrinketType, string>;

package/dist/maps/trinketNameMap.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare const TRINKET_NAME_MAP: Map<TrinketType, string>;
+export declare const TRINKET_NAME_MAP: ReadonlyMap<TrinketType, string>;

package/dist/sets/cards.d.ts

@@ -3,23 +3,23 @@
  * Contains all of the entries in the `Card` enum that are not a rune and not an object (e.g. Fool,
  * Reverse Fool, Wild Card, etc.).
  */
-export declare const CARDS: Card[];
+export declare const CARDS: readonly Card[];
 /**
  * Contains all of the entries in the `Card` enum that are not a rune and not an object (e.g. Fool,
  * Reverse Fool, Wild Card, etc.).
  */
-export declare const CARD_SET: Set<Card>;
+export declare const CARD_SET: ReadonlySet<Card>;
 /**
  * Contains all of the entries in the `Card` enum that are a rune (e.g. Rune of Hagalaz, Blank Rune,
  * Black Rune, Rune Shard, Soul of Isaac, etc.).
  */
-export declare const RUNES: Card[];
+export declare const RUNES: readonly Card[];
 /**
  * Contains all of the entries in the `Card` enum that are a rune (e.g. Rune of Hagalaz, Blank Rune,
  * Black Rune, Rune Shard, Soul of Isaac, etc.).
  */
-export declare const RUNE_SET: Set<Card>;
+export declare const RUNE_SET: ReadonlySet<Card>;
 /** Contains all of the entries in the `Card` enum that are objects (like Dice Shard). */
-export declare const POCKET_ITEM_OBJECTS: Card[];
+export declare const POCKET_ITEM_OBJECTS: readonly Card[];
 /** Contains all of the entries in the `Card` enum that are objects (like Dice Shard). */
-export declare const POCKET_ITEM_OBJECT_SET: Set<Card>;
+export declare const POCKET_ITEM_OBJECT_SET: ReadonlySet<Card>;

package/package.json

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