isaacscript-common 1.2.192 → 1.2.195

package/dist/functions/player.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
 import { HealthType } from "../enums/HealthType";
-import { PlayerIndex } from "../types/PlayerIndex";
 export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
 export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 export declare function anyPlayerHasCollectible(collectibleType: CollectibleType | int): boolean;
@@ -23,37 +22,10 @@ export declare function anyPlayerIs(...matchingCharacters: Array<PlayerType | in
  */
 export declare function canPlayerCrushRocks(player: EntityPlayer): boolean;
 /**
- * Helper function for detecting when a player is one of the characters that can take free Devil
- * Deals. (e.g. The Lost, Tainted Lost, etc.)
+ * Helper function to find the active slot that the player has the corresponding collectible type
+ * in. Returns undefined if the player does not have the collectible in any active slot.
  */
-export declare function canTakeFreeDevilDeals(player: EntityPlayer): boolean;
-/**
- * Helper function to determine if the provided character can have red heart containers. Returns
- * true for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper,
- * even though coin containers are not technically the same as red heart containers. Returns false
- * for characters like Blue Baby. Returns false for The Lost and Tainted Lost.
- */
-export declare function characterCanHaveRedHearts(character: PlayerType | int): boolean;
-/**
- * Helper function to determine if the provided character can have soul hearts. Returns true for
- * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
- * false for The Lost and Tainted Lost.
- */
-export declare function characterCanHaveSoulHearts(character: PlayerType | int): boolean;
-/**
- * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
- * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
- * Otherwise, returns false.
- */
-export declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType | int): boolean;
-/**
- * Helper function to get every player with no restrictions, by using `Game.GetNumPlayers` and
- * `Isaac.GetPlayer`.
- *
- * This function is almost never what you want to use. For most purposes, use the `getPlayers`
- * helper function instead to get a filtered list of players.
- */
-export declare function getAllPlayers(): EntityPlayer[];
+export declare function getActiveItemSlot(player: EntityPlayer, collectibleType: CollectibleType | int): ActiveSlot | undefined;
 /**
  * Helper function to get how long Azazel's Brimstone laser should be. You can pass either an
  * `EntityPlayer` object or a tear height stat.
@@ -61,31 +33,9 @@ export declare function getAllPlayers(): EntityPlayer[];
  * The formula for calculating it is: 32 - 2.5 * player.TearHeight
  */
 export declare function getAzazelBrimstoneDistance(playerOrTearHeight: EntityPlayer | float): float;
-/**
- * Returns the number of black hearts that the player has, excluding any soul hearts. For example,
- * if the player has one full black heart, one full soul heart, and one half black heart, this
- * function returns 3.
- *
- * This is different from the `EntityPlayer.GetBlackHearts` method, since that returns a bitmask.
- */
-export declare function getBlackHearts(player: EntityPlayer): int;
-/**
- * Returns the maximum heart containers that the provided character can have. Normally, this is 12,
- * but with Keeper it is 3, and with Tainted Keeper it is 2. This does not account for Birthright or
- * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
- */
-export declare function getCharacterMaxHeartContainers(character: PlayerType | int): int;
-/** Helper function to get the name of a character. Returns "unknown" for modded characters. */
-export declare function getCharacterName(character: PlayerType | int): string;
 /** Helper function to get an array containing the characters of all of the current players. */
 export declare function getCharacters(): PlayerType[];
 export declare function getClosestPlayer(position: Vector): EntityPlayer;
-/**
- * Most characters have a 56 frame death animation (i.e. the "Death" animation).
- * The Lost and Tainted Lost have a 38 frame death animation (i.e. the "LostDeath" animation).
- * Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
- */
-export declare function getDeathAnimationName(player: EntityPlayer): string;
 /**
  * Helper function to get an array of temporary effects for a player. This is helpful so that you
  * don't have to manually create an array from an `EffectsList` object.
@@ -96,20 +46,6 @@ export declare function getEffectsList(player: EntityPlayer): TemporaryEffect[];
  * method.
  */
 export declare function getFinalPlayer(): EntityPlayer;
-/**
- * Returns the number of red hearts that the player has, excluding any rotten hearts. For example,
- * if the player has one full black heart, one full soul heart, and one half black heart, this
- * function returns 3.
- *
- * This is different from the `EntityPlayer.GetHearts` method, since that returns a value that
- * includes rotten hearts.
- */
-export declare function getHearts(player: EntityPlayer): int;
-/**
- * Helper function that returns the type of the rightmost heart. This does not including golden
- * hearts or broken hearts, since they cannot be damaged directly.
- */
-export declare function getLastHeart(player: EntityPlayer): HealthType;
 /**
  * Helper function to get the first player with the lowest frame count. Useful to find a freshly
  * spawned player after using items like Esau Jr. Don't use this function if two or more players
@@ -122,6 +58,14 @@ export declare function getNewestPlayer(): EntityPlayer;
  * soul hearts and 3 broken hearts, then this function would return 6 (i.e. 12 - 1 - 2 - 3).
  */
 export declare function getPlayerAvailableHeartSlots(player: EntityPlayer): int;
+/**
+ * Returns the number of black hearts that the player has, excluding any soul hearts. For example,
+ * if the player has one full black heart, one full soul heart, and one half black heart, this
+ * function returns 3.
+ *
+ * This is different from the `EntityPlayer.GetBlackHearts` method, since that returns a bitmask.
+ */
+export declare function getPlayerBlackHearts(player: EntityPlayer): int;
 /**
  * Iterates over all players and checks if any are close enough to the specified position.
  *
@@ -133,42 +77,20 @@ export declare function getPlayerCloserThan(position: Vector, distance: float):
  * the player has.
  */
 export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType | int, int>;
-export declare function getPlayerFromIndex(playerIndex: PlayerIndex): EntityPlayer | undefined;
 /**
- * Mods often have to track variables relating to the player. In naive mods, information will only
- * be stored about the first player. However, in order to be robust, mods must handle up to 4
- * players playing at the same time. This means that information must be stored on a map data
- * structure. Finding a good index for these types of map data structures is difficult:
- *
- * - We cannot use the index from `Isaac.GetPlayer(i)` since this fails in the case where there are
- *   two players and the first player leaves the run.
- * - We cannot use `EntityPlayer.ControllerIndex` as an index because it fails in the case of Jacob
- *   & Esau or Tainted Forgotten. It also fails in the case of a player changing their controls
- *   mid-run.
- * - We cannot use `EntityPlayer.GetData().index` because it does not persist across saving and
- *   continuing.
- * - We cannot use `GetPtrHash()` as an index because it does not persist across exiting and
- *   relaunching the game.
- * - We cannot use `EntityPlayer.InitSeed` because it is not consistent with additional players
- *   beyond the first.
- *
- * Instead, we use the `EntityPlayer.GetCollectibleRNG` method with an arbitrary value of Sad Onion
- * (1). This works even if the player does not have any Sad Onions.
- *
- * Since the RNG value is the same for both Tainted Lazarus and Dead Tainted Lazarus, we revert to
- * using the RNG of The Inner Eye (2) for Dead Tainted Lazarus.
+ * Returns the number of red hearts that the player has, excluding any rotten hearts. For example,
+ * if the player has one full black heart, one full soul heart, and one half black heart, this
+ * function returns 3.
  *
- * Note that by default, this returns the same index for both The Forgotten and The Soul. (Even
- * though they are technically different characters, they share the same inventory and InitSeed.) If
- * this is not desired, pass true for the `differentiateForgottenAndSoul` argument, and the RNG of
- * Spoon Bender (3) will be used for The Soul.
+ * This is different from the `EntityPlayer.GetHearts` method, since that returns a value that
+ * includes rotten hearts.
  */
-export declare function getPlayerIndex(player: EntityPlayer, differentiateForgottenAndSoul?: boolean): PlayerIndex;
+export declare function getPlayerHearts(player: EntityPlayer): int;
 /**
- * Helper function to return the index of this player with respect to the output of the
- * `Isaac.GetPlayer` method.
+ * Helper function that returns the type of the rightmost heart. This does not including golden
+ * hearts or broken hearts, since they cannot be damaged directly.
  */
-export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int | undefined;
+export declare function getPlayerLastHeart(player: EntityPlayer): HealthType;
 /**
  * Returns the maximum heart containers that the provided player can have. Normally, this is 12, but
  * it can change depending on the character (e.g. Keeper) and other things (e.g. Mother's Kiss).
@@ -193,15 +115,14 @@ export declare function getPlayerName(player: EntityPlayer): string;
  */
 export declare function getPlayerNumHitsRemaining(player: EntityPlayer): int;
 /**
- * This function always excludes players with a non-undefined parent, since they are not real
- * players. (e.g. the Strawman Keeper)
- *
- * If this is not desired, use the `getAllPlayers` helper function instead.
+ * Returns the number of soul hearts that the player has, excluding any black hearts. For example,
+ * if the player has one full black heart, one full soul heart, and one half black heart, this
+ * function returns 2.
  *
- * @param performCharacterExclusions Whether or not to exclude characters that are not directly
- * controlled by the player (i.e. Esau & Tainted Soul). Default is false.
+ * This is different from the `EntityPlayer.GetSoulHearts` method, since that returns the combined
+ * number of soul hearts and black hearts.
  */
-export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
+export declare function getPlayerSoulHearts(player: EntityPlayer): int;
 /**
  * Helper function to get all of the players that are a certain character.
  *
@@ -216,21 +137,6 @@ export declare function getPlayersOfType(...characters: Array<PlayerType | int>)
  * check for. It only returns the players that have all of the collectibles.
  */
 export declare function getPlayersWithCollectible(...collectibleTypes: Array<CollectibleType | int>): EntityPlayer[];
-/**
- * Returns the number of soul hearts that the player has, excluding any black hearts. For example,
- * if the player has one full black heart, one full soul heart, and one half black heart, this
- * function returns 2.
- *
- * This is different from the `EntityPlayer.GetSoulHearts` method, since that returns the combined
- * number of soul hearts and black hearts.
- */
-export declare function getSoulHearts(player: EntityPlayer): int;
-/**
- * Helper function to get a parent `EntityPlayer` object for a given `EntitySubPlayer` object. This
- * is useful because calling the `EntityPlayer.GetSubPlayer` method on a sub-player object will
- * return undefined.
- */
-export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPlayer | undefined;
 /**
  * Helper function to determine how many heart containers that Tainted Magdalene has that will not
  * be automatically depleted over time. By default, this is 2, but this function will return 4 so
@@ -264,11 +170,6 @@ export declare function isActiveSlotEmpty(player: EntityPlayer, activeSlot: Acti
  * charges.
  */
 export declare function isBethany(player: EntityPlayer): boolean;
-/**
- * Some players are "child" players, meaning that they have a non-undefined Parent property.
- * (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.