isaacscript-common 1.2.10 → 1.2.14

package/dist/functions/player.d.ts

@@ -59,6 +59,10 @@ export declare function getClosestPlayer(position: Vector): EntityPlayer;
  * Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
  */
 export declare function getDeathAnimationName(player: EntityPlayer): string;
+/**
+ * Helper function to return the player with the highest index, according to the
+ * `Isaac.GetPlayer()` method.
+ */
 export declare function getFinalPlayer(): EntityPlayer;
 /**
  * Helper function that returns the type of the rightmost heart, not including golden hearts since
@@ -132,8 +136,9 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  */
 export declare function getPlayerMaxHeartContainers(player: EntityPlayer): int;
 /**
- * Helper function to get the name of the player. Use this instead of the `EntityPlayer.GetName`
- * method if you want the name to fill in "???" and include the "Tainted" prefix.
+ * Helper function to get the proper name of the player. Use this instead of the
+ * `EntityPlayer.GetName` method because it accounts for Blue Baby, Lazarus II, and Tainted
+ * characters.
  */
 export declare function getPlayerName(player: EntityPlayer): string;
 /**
@@ -216,6 +221,12 @@ export declare function canTakeFreeDevilDeals(player: EntityPlayer): boolean;
 export declare function isTainted(player: EntityPlayer): boolean;
 /** Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus. */
 export declare function isTaintedLazarus(player: EntityPlayer): boolean;
+export declare function isModdedCharacter(player: EntityPlayer): boolean;
+export declare function isVanillaCharacter(player: EntityPlayer): boolean;
+/**
+ * Helper function to remove a collectible costume from a player. Use this helper function to avoid
+ * having to request the collectible from the item config.
+ */
 export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
 /**
  * Helper function to remove the Dead Eye multiplier from a player.
@@ -224,6 +235,10 @@ export declare function removeCollectibleCostume(player: EntityPlayer, collectib
  * chance of working, so this function calls it 100 times to be safe.
  */
 export declare function removeDeadEyeMultiplier(player: EntityPlayer): void;
+/**
+ * Helper function to remove a trinket costume from a player. Use this helper function to avoid
+ * having to request the trinket from the item config.
+ */
 export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 /**
  * Helper function to set an active collectible to a particular slot. This has different behavior

package/dist/functions/player.lua

@@ -9,7 +9,7 @@ local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local EXCLUDED_CHARACTERS
+local getAdjustedPlayerName, isTaintedModded, EXCLUDED_CHARACTERS
 local ____constants = require("constants")
 local CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART = ____constants.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART
 local CHARACTERS_WITH_FREE_DEVIL_DEALS = ____constants.CHARACTERS_WITH_FREE_DEVIL_DEALS
@@ -17,6 +17,7 @@ local CHARACTERS_WITH_NO_RED_HEARTS = ____constants.CHARACTERS_WITH_NO_RED_HEART
 local CHARACTERS_WITH_NO_SOUL_HEARTS = ____constants.CHARACTERS_WITH_NO_SOUL_HEARTS
 local LOST_STYLE_PLAYER_TYPES = ____constants.LOST_STYLE_PLAYER_TYPES
 local MAX_PLAYER_HEART_CONTAINERS = ____constants.MAX_PLAYER_HEART_CONTAINERS
+local MAX_VANILLA_CHARACTER = ____constants.MAX_VANILLA_CHARACTER
 local ____HealthType = require("types.HealthType")
 local HealthType = ____HealthType.HealthType
 local ____array = require("functions.array")
@@ -30,6 +31,7 @@ local ____collectibleSet = require("functions.collectibleSet")
 local getCollectibleSet = ____collectibleSet.getCollectibleSet
 local ____util = require("functions.util")
 local ensureAllCases = ____util.ensureAllCases
+local stringContains = ____util.stringContains
 local trimPrefix = ____util.trimPrefix
 function ____exports.getCharacterMaxHeartContainers(self, character)
     if character == PlayerType.PLAYER_KEEPER then
@@ -67,6 +69,53 @@ function ____exports.getPlayerMaxHeartContainers(self, player)
     end
     return maxHeartContainers
 end
+function getAdjustedPlayerName(self, player)
+    local character = player:GetPlayerType()
+    repeat
+        local ____switch71 = character
+        local ____cond71 = ____switch71 == PlayerType.PLAYER_BLUEBABY or ____switch71 == PlayerType.PLAYER_BLUEBABY_B
+        if ____cond71 then
+            do
+                return "Blue Baby"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_LAZARUS2
+        if ____cond71 then
+            do
+                return "Lazarus II"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_BLACKJUDAS
+        if ____cond71 then
+            do
+                return "Dark Judas"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_JACOB
+        if ____cond71 then
+            do
+                return "Jacob & Esau"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_LAZARUS2_B
+        if ____cond71 then
+            do
+                return "Dead Tainted Lazarus"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_JACOB2_B
+        if ____cond71 then
+            do
+                return "Dead Tainted Jacob"
+            end
+        end
+        do
+            do
+                return player:GetName()
+            end
+        end
+    until true
+end
 function ____exports.getPlayers(self, performExclusions)
     if performExclusions == nil then
         performExclusions = false
@@ -79,18 +128,18 @@ function ____exports.getPlayers(self, performExclusions)
             do
                 local player = Isaac.GetPlayer(i)
                 if player == nil then
-                    goto __continue72
+                    goto __continue81
                 end
                 if ____exports.isChildPlayer(nil, player) then
-                    goto __continue72
+                    goto __continue81
                 end
                 local character = player:GetPlayerType()
                 if performExclusions and EXCLUDED_CHARACTERS:has(character) then
-                    goto __continue72
+                    goto __continue81
                 end
                 __TS__ArrayPush(players, player)
             end
-            ::__continue72::
+            ::__continue81::
             i = i + 1
         end
     end
@@ -101,7 +150,26 @@ function ____exports.isChildPlayer(self, player)
 end
 function ____exports.isTainted(self, player)
     local character = player:GetPlayerType()
-    return character >= PlayerType.PLAYER_ISAAC_B
+    local ____isVanillaCharacter_result_0
+    if ____exports.isVanillaCharacter(nil, player) then
+        ____isVanillaCharacter_result_0 = character >= PlayerType.PLAYER_ISAAC_B
+    else
+        ____isVanillaCharacter_result_0 = isTaintedModded(nil, player)
+    end
+    return ____isVanillaCharacter_result_0
+end
+function isTaintedModded(self, player)
+    local character = player:GetPlayerType()
+    local name = player:GetName()
+    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
+    return character == taintedCharacter
+end
+function ____exports.isModdedCharacter(self, player)
+    local character = player:GetPlayerType()
+    return character > MAX_VANILLA_CHARACTER
+end
+function ____exports.isVanillaCharacter(self, player)
+    return not ____exports.isModdedCharacter(nil, player)
 end
 EXCLUDED_CHARACTERS = __TS__New(Set, {PlayerType.PLAYER_ESAU, PlayerType.PLAYER_THESOUL_B})
 function ____exports.addCollectibleCostume(self, player, collectibleType)
@@ -313,13 +381,12 @@ function ____exports.getPlayerIndexVanilla(self, playerToFind)
     return nil
 end
 function ____exports.getPlayerName(self, player)
-    local name = player:GetName()
-    local filledInName = name == "???" and "Blue Baby" or name
+    local adjustedName = getAdjustedPlayerName(nil, player)
     if not ____exports.isTainted(nil, player) then
-        return filledInName
+        return adjustedName
     end
-    local baseName = trimPrefix(nil, filledInName, "The ")
-    return "Tainted " .. baseName
+    local baseName = trimPrefix(nil, adjustedName, "The ")
+    return stringContains(nil, baseName, "Tainted") and baseName or "Tainted " .. baseName
 end
 function ____exports.getPlayerNumHitsRemaining(self, player)
     local hearts = player:GetHearts()
@@ -477,9 +544,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch112 = activeSlot
-        local ____cond112 = ____switch112 == ActiveSlot.SLOT_PRIMARY
-        if ____cond112 then
+        local ____switch124 = activeSlot
+        local ____cond124 = ____switch124 == ActiveSlot.SLOT_PRIMARY
+        if ____cond124 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -488,8 +555,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_SECONDARY
-        if ____cond112 then
+        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_SECONDARY
+        if ____cond124 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -504,16 +571,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_POCKET
-        if ____cond112 then
+        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_POCKET
+        if ____cond124 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_POCKET2
-        if ____cond112 then
+        ____cond124 = ____cond124 or ____switch124 == ActiveSlot.SLOT_POCKET2
+        if ____cond124 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/util.d.ts

@@ -80,6 +80,7 @@ export declare function onSetSeed(): boolean;
  * message (which `Isaac.ConsoleOutput()` does not do by default).
  */
 export declare function printConsole(msg: string): void;
+export declare function stringContains(string: string, searchString: string): boolean;
 /**
  * In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
  * `clear` method does not exist. Use this helper function as a drop-in replacement for this.

package/dist/functions/util.lua

@@ -67,6 +67,9 @@ end
 function ____exports.printConsole(self, msg)
     Isaac.ConsoleOutput(msg .. "\n")
 end
+function ____exports.stringContains(self, ____string, searchString)
+    return (string.find(____string, searchString, nil, true) or 0) - 1 ~= -1
+end
 function ____exports.tableClear(self, ____table)
     for key in pairs(____table) do
         ____table[key] = nil

package/dist/index.d.ts

@@ -74,6 +74,8 @@ export * from "./types/JSONSpawn";
 export * from "./types/ModCallbacksCustom";
 export * from "./types/ModUpgraded";
 export * from "./types/PickingUpItem";
+export * from "./types/PillEffectClass";
+export * from "./types/PillEffectType";
 export * from "./types/PlayerHealth";
 export * from "./types/PocketItemDescription";
 export * from "./types/PocketItemType";

package/dist/index.lua

@@ -534,6 +534,22 @@ do
         end
     end
 end
+do
+    local ____export = require("types.PillEffectClass")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.PillEffectType")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("types.PocketItemType")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/types/PillEffectClass.d.ts

@@ -0,0 +1,7 @@
+/** Equal to the "class" tag in the "pocketitems.xml" file. */
+export declare enum PillEffectClass {
+    JOKE = 0,
+    MINOR = 1,
+    MEDIUM = 2,
+    MAJOR = 3
+}

package/dist/types/PillEffectClass.lua

@@ -0,0 +1,12 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.PillEffectClass = PillEffectClass or ({})
+____exports.PillEffectClass.JOKE = 0
+____exports.PillEffectClass[____exports.PillEffectClass.JOKE] = "JOKE"
+____exports.PillEffectClass.MINOR = 1
+____exports.PillEffectClass[____exports.PillEffectClass.MINOR] = "MINOR"
+____exports.PillEffectClass.MEDIUM = 2
+____exports.PillEffectClass[____exports.PillEffectClass.MEDIUM] = "MEDIUM"
+____exports.PillEffectClass.MAJOR = 3
+____exports.PillEffectClass[____exports.PillEffectClass.MAJOR] = "MAJOR"
+return ____exports

package/dist/types/PillEffectType.d.ts

@@ -0,0 +1,5 @@
+export declare enum PillEffectType {
+    GOOD = 0,
+    BAD = 1,
+    NEUTRAL = 2
+}

package/dist/types/PillEffectType.lua

@@ -0,0 +1,10 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.PillEffectType = PillEffectType or ({})
+____exports.PillEffectType.GOOD = 0
+____exports.PillEffectType[____exports.PillEffectType.GOOD] = "GOOD"
+____exports.PillEffectType.BAD = 1
+____exports.PillEffectType[____exports.PillEffectType.BAD] = "BAD"
+____exports.PillEffectType.NEUTRAL = 2
+____exports.PillEffectType[____exports.PillEffectType.NEUTRAL] = "NEUTRAL"
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.10",
+  "version": "1.2.14",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.336",
+    "isaac-typescript-definitions": "^1.0.337",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",