isaacscript-common 1.2.112 → 1.2.113

package/dist/features/deployJSONRoom.d.ts

@@ -15,9 +15,9 @@ import { JSONRoom } from "../types/JSONRoom";
  * deployJSONRoom(firstJSONRoom);
  * ```
  * @param seed Optional. Specifies the seed that will be used for spawning every entity in the room.
- * Equal to `Random()` by default.
+ * Default is `Random()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
- * what the function is doing. False by default.
+ * what the function is doing. Default is false.
  * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed()`. The
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
@@ -43,9 +43,9 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: number, verbos
  * deployRandomJSONRoom(jsonRooms);
  * ```
  * @param seed Optional. Specifies the seed that will be used for determining the random room. After
- * that, it is also used for spawning every entity in the room. Equal to `Random()` by default.
+ * that, it is also used for spawning every entity in the room. Default is `Random()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
- * what the function is doing. False by default.
+ * what the function is doing. Default is false.
  * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed()`. The
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
@@ -59,6 +59,6 @@ export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seed?: numbe
  *
  * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
  * decoration, which prevents vanilla entities in the room from respawning the next time that the
- * player enters. False by default.
+ * player enters. Default is false.
  */
 export declare function emptyRoom(fillWithDecorations: boolean): void;

package/dist/functions/array.d.ts

@@ -67,7 +67,7 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T
  * Helper function to get a random element from the provided array.
  *
  * @param array The array to get an element from.
- * @param seed Optional. The seed used to select the random element. `Random()` by default.
+ * @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;
@@ -76,7 +76,7 @@ export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed
  * decided, it is then removed from the array (in-place).
  *
  * @param array The array to get an element from.
- * @param seed Optional. The seed used to select the random element. `Random()` by default.
+ * @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;

package/dist/functions/cards.d.ts

@@ -37,13 +37,13 @@ export declare function getMaxCards(): int;
  * - any objects like Dice Shard
  * - any modded cards.
  *
- * @param seed Optional. The seed with which to select the random card. `Random()` by default.
+ * @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;
 /**
  * @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. `Random()` by default.
+ * @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;
@@ -51,7 +51,7 @@ export declare function getRandomCardOfType(cardType: CardType, seed?: number, e
  * 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.
  *
- * @param seed Optional. The seed with which to select the random rune. `Random()` by default.
+ * @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;

package/dist/functions/charge.d.ts

@@ -9,7 +9,7 @@
  * - AAA Battery
  *
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. False by default.
+ * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
 export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean): void;
 /**
@@ -23,7 +23,7 @@ export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean)
  *
  * @param player The player to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. False by default.
+ * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
 export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDoubleCharge?: boolean): void;
 /**
@@ -38,7 +38,7 @@ export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDo
  * @param player The player to grant the charges to.
  * @param activeSlot The active item slot to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. False by default.
+ * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
 export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, ignoreBigRoomDoubleCharge?: boolean): void;
 export declare function playChargeSoundEffect(player: EntityPlayer, activeSlot: ActiveSlot): void;

package/dist/functions/deepCopy.d.ts

@@ -20,8 +20,8 @@ export declare enum SerializationType {
  *
  * @param oldObject The object to copy.
  * @param serializationType Has 3 possible values. Can leave TypeScriptToLua objects as-is, or can
- * serialize objects to Lua tables, or can deserialize Lua tables to objects. Will perform no
- * serialization by default.
+ * serialize objects to Lua tables, or can deserialize Lua tables to objects. Defaults to
+ * `SerializationType.NONE`.
  * @param traversalDescription Used to track the current key that we are operating on.
  */
 export declare function deepCopy(oldObject: LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>, serializationType?: SerializationType, traversalDescription?: string): LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>;

package/dist/functions/entity.d.ts

@@ -6,10 +6,10 @@ export declare function anyEntityCloserThan(entities: Entity[], position: Vector
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
  * enemies.
  *
- * @param entityType -1 by default.
- * @param variant -1 by default.
- * @param subType -1 by default.
- * @param ignoreFriendly False by default.
+ * @param entityType Default is -1.
+ * @param variant Default is -1.
+ * @param subType Default is -1.
+ * @param ignoreFriendly Default is false.
  */
 export declare function countEntities(entityType?: EntityType | int, variant?: number, subType?: number, ignoreFriendly?: boolean): number;
 /**
@@ -50,7 +50,7 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
  * @param matchingVariant Optional. If specified, will only return NPCs that match this variant.
  * @param matchingSubType Optional. If specified, will only return NPCs that match this sub-type.
  * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
- * returned. False by default. Will only be taken into account if `matchingEntityType` is specified.
+ * returned. Default is false. Will only be taken into account if `matchingEntityType` is specified.
  */
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
 /** Helper function to return a string containing an entity's type, variant, and sub-type. */
@@ -59,7 +59,7 @@ export declare function getEntityID(entity: Entity): string;
  * Helper function to measure an entity's velocity to see if it is moving.
  *
  * @param entity The entity whose velocity to measure.
- * @param threshold Optional. The threshold from 0 to consider to be moving. 0.01 by default.
+ * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */
 export declare function isEntityMoving(entity: Entity, threshold?: number): boolean;
 /**
@@ -80,9 +80,9 @@ export declare function removeEntities(entities: Entity[], cap?: int): boolean;
  * Helper function to remove all of the matching entities in the room.
  *
  * @param entityType The entity type to match.
- * @param entityVariant Optional. The variant to match. -1 by default (which will match every
+ * @param entityVariant Optional. The variant to match. Default is -1 (which will match every
  * variant).
- * @param entitySubType Optional. The sub-type to match. -1 by default (which will match every
+ * @param entitySubType Optional. The sub-type to match. Default is -1 (which will match every
  * sub-type).
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more entities was removed, false otherwise.

package/dist/functions/gridEntity.d.ts

@@ -100,7 +100,7 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
  *
  * @param gridEntity The grid entity to remove.
  * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
- * True by default. This is generally a good idea because if the room is not updated, you will be
+ * Default is true. This is generally a good idea because if the room is not updated, you will be
  * unable to spawn another grid entity on the same tile until a frame has passed. However, doing
  * this is expensive, since it involves a call to `Isaac.GetRoomEntities()`, so set it to false if
  * you need to invoke this function multiple times.

package/dist/functions/npc.d.ts

@@ -6,10 +6,10 @@
  * @param npc The NPC to fire the projectile from.
  * @param position The staring position of the projectile.
  * @param velocity The starting velocity of the projectile.
- * @param projectilesMode The mode of the projectile. Optional. Equal to
- * `ProjectilesMode.ONE_PROJECTILE` by default.
- * @param projectileParams The parameters of the projectile. Optional. Equal to `ProjectileParams()`
- * by default.
+ * @param projectilesMode The mode of the projectile. Optional. Default is
+ * `ProjectilesMode.ONE_PROJECTILE`.
+ * @param projectileParams The parameters of the projectile. Optional. Default is
+ * `ProjectileParams()`.
  * @returns The fired projectile.
  */
 export declare function fireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode?: ProjectilesMode, projectileParams?: ProjectileParams): EntityProjectile[];

package/dist/functions/player.d.ts

@@ -183,7 +183,7 @@ export declare function getPlayerNumHitsRemaining(player: EntityPlayer): int;
  * If this is not desired, use the `getAllPlayers` helper function instead.
  *
  * @param performCharacterExclusions Whether or not to exclude characters that are not directly
- * controlled by the player (i.e. Esau & Tainted Soul). False by default.
+ * controlled by the player (i.e. Esau & Tainted Soul). Default is false.
  */
 export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
 /**
@@ -304,7 +304,7 @@ export declare function removeTrinketCostume(player: EntityPlayer, trinketType:
  * @param activeSlot The slot to set.
  * @param charge Optional. The argument of charges to set. If not specified, the item will be set
  * with maximum charges.
- * @param keepInPools Optional. Whether or not to remove the item from pools. False by default.
+ * @param keepInPools Optional. Whether or not to remove the item from pools. Default is false.
  */
 export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot: ActiveSlot, charge?: int, keepInPools?: boolean): void;
 /**
@@ -314,7 +314,7 @@ export declare function setActiveItem(player: EntityPlayer, collectibleType: Col
  *
  * @param player The player to apply or remove the blindfold state from.
  * @param enabled Whether or not to apply or remove the blindfold.
- * @param modifyCostume Optional. Whether to add or remove the blindfold costume. True by default.
+ * @param modifyCostume Optional. Whether to add or remove the blindfold costume. Default is true.
  */
 export declare function setBlindfold(player: EntityPlayer, enabled: boolean, modifyCostume?: boolean): void;
 /**

package/dist/functions/playerHealth.lua

@@ -6,6 +6,7 @@ local ____exports = {}
 local ____constants = require("constants")
 local MAX_PLAYER_HEART_CONTAINERS = ____constants.MAX_PLAYER_HEART_CONTAINERS
 function ____exports.removeAllPlayerHealth(self, player)
+    local character = player:GetPlayerType()
     local goldenHearts = player:GetGoldenHearts()
     local eternalHearts = player:GetEternalHearts()
     local boneHearts = player:GetBoneHearts()
@@ -16,6 +17,13 @@ function ____exports.removeAllPlayerHealth(self, player)
     player:AddBrokenHearts(brokenHearts * -1)
     player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
     player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
+    if character == PlayerType.PLAYER_THESOUL then
+        local forgotten = player:GetSubPlayer()
+        if forgotten ~= nil then
+            local forgottenBoneHearts = forgotten:GetBoneHearts()
+            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
+        end
+    end
 end
 function ____exports.getPlayerHealth(self, player)
     local character = player:GetPlayerType()

package/dist/functions/positionVelocity.d.ts

@@ -8,7 +8,7 @@
  *
  * @param startingPosition The position to start searching from. If this position is not overlapping
  * with anything, then it will be returned.
- * @param avoidActiveEntities Optional. False by default.
+ * @param avoidActiveEntities Optional. Default is false.
  */
 export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean): Vector;
 /**

package/dist/functions/rooms.d.ts

@@ -22,20 +22,20 @@ export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOn
 /**
  * Helper function to get the room data for the provided room.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined;
 /**
  * Helper function for getting the type of the room with the given grid index.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room data type. Returns -1 if the type was not found.
  */
 export declare function getRoomType(roomGridIndex?: int): RoomType;
 /**
  * Helper function to get the descriptor for a room.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
 /**
@@ -78,13 +78,13 @@ export declare function getRoomItemPoolType(): ItemPoolType;
  * Use this as an index for data structures that store data per room, since it is unique across
  * different dimensions.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomListIndex(roomGridIndex?: int): int;
 /**
  * Helper function to get the name of the room as it appears in the STB/XML data.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room name. Returns "Unknown" if the type was not found.
  */
 export declare function getRoomName(roomGridIndex?: int): string;
@@ -93,7 +93,7 @@ export declare function getRoomName(roomGridIndex?: int): string;
  * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
  * would have a stage ID of 7.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room stage ID. Returns -1 if the stage ID was not found.
  */
 export declare function getRoomStageID(roomGridIndex?: int): StageID;
@@ -103,7 +103,7 @@ export declare function getRoomStageID(roomGridIndex?: int): StageID;
  * "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
  * Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room sub-type. Returns -1 if the sub-type was not found.
  */
 export declare function getRoomSubType(roomGridIndex?: int): int;
@@ -112,7 +112,7 @@ export declare function getRoomSubType(roomGridIndex?: int): int;
  * variant as its identifier. For example, to go to Basement room #123, you would use a console
  * command of `goto d.123` while on the Basement.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room variant. Returns -1 if the variant was not found.
  */
 export declare function getRoomVariant(roomGridIndex?: int): int;
@@ -121,7 +121,7 @@ export declare function getRoomVariant(roomGridIndex?: int): int;
  * callback has fired (i.e. when entities are initializing and performing their first update). This
  * is because the variable is only incremented immediately before the PostNewRoom callback fires.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomVisitedCount(roomGridIndex?: int): int;
 /**
@@ -130,7 +130,7 @@ export declare function getRoomVisitedCount(roomGridIndex?: int): int;
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
  * extra-dimensional rooms are automatically be generated and can be seen when you iterate over the
- * `RoomList`. False by default.
+ * `RoomList`. Default is false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
@@ -205,14 +205,14 @@ export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolea
  * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
  * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
 /**
  * Helper function to determine if the provided room is part of the floor layout. For
  * example, Devil Rooms and the Mega Satan room are not considered to be inside the map.
  *
- * @param roomGridIndex Optional. Equal to the current room index by default.
+ * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
 /**

package/dist/functions/set.d.ts

@@ -24,7 +24,7 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  * Helper function to get a random element from the provided set.
  *
  * @param set The set to get an element from.
- * @param seed Optional. The seed used to select the random element. `Random()` by default.
+ * @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;

package/dist/functions/spawnCollectible.d.ts

@@ -6,11 +6,11 @@
  *
  * @param collectibleType The collectible type to spawn.
  * @param position The position to spawn the collectible at.
- * @param seed Optional. Random() by default.
+ * @param seed Optional. Default is `Random()`.
  * @param options Optional. Set to true to make the collectible a "There's Options" style
- * collectible. False by default.
+ * collectible. Default is false.
  * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
- * Tainted Keeper. False by default.
+ * Tainted Keeper. Default is false.
  */
 export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seed?: number, options?: boolean, forceFreeItem?: boolean): EntityPickup;
 /**

package/dist/functions/trinkets.d.ts

@@ -49,7 +49,7 @@ export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean
  * @param player The player to smelt the trinkets to.
  * @param trinketType The trinket type to smelt.
  * @param numTrinkets Optional. If specified, will smelt the given number of trinkets. Use this to
- * avoid calling this function multiple times. 1 by default.
+ * avoid calling this function multiple times. Default is 1.
  */
 export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType | int, numTrinkets?: number): void;
 export declare function trinketHasCacheFlag(trinketType: TrinketType | int, cacheFlag: CacheFlag): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.112",
+  "version": "1.2.113",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,10 +26,10 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.2",
-    "isaac-typescript-definitions": "^1.0.355",
+    "isaac-typescript-definitions": "^1.0.357",
     "isaacscript-lint": "^1.0.84",
     "isaacscript-tsconfig": "^1.1.8",
-    "typedoc": "^0.22.12",
+    "typedoc": "^0.22.13",
     "typescript": "4.5.5"
   }
 }