isaacscript-common 1.0.540 → 1.0.544

package/dist/functions/cards.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to get a card name from a Card.
+ * Helper function to get a card description from a Card enum value.
  *
  * Example:
  * ```
  * const card = Card.CARD_FOOL;
- * const cardName = getCardName(card); // cardName is "0 - The Fool"
+ * const cardDescription = getCardDescription(card); // cardDescription is "Where journey begins"
  * ```
  */
 export declare function getCardDescription(card: Card | int): string;

package/dist/functions/entity.d.ts

@@ -152,6 +152,13 @@ export declare function getSlots(matchingVariant?: number, matchingSubType?: num
  * ```
  */
 export declare function getTears(matchingVariant?: number, matchingSubType?: number): EntityTear[];
+/**
+ * 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.
+ */
+export declare function isEntityMoving(entity: Entity, threshold?: number): boolean;
 /**
  * Helper function to remove all of the entities in the supplied array.
  *

package/dist/functions/entity.lua

@@ -210,6 +210,12 @@ function ____exports.getTears(self, matchingVariant, matchingSubType)
     end
     return tears
 end
+function ____exports.isEntityMoving(self, entity, threshold)
+    if threshold == nil then
+        threshold = 0.01
+    end
+    return entity.Velocity:Length() >= threshold
+end
 function ____exports.removeEntities(self, entities, cap)
     local numEntitiesRemoved = 0
     do

package/dist/functions/pills.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to get a pill effect name from a PillEffect.
+ * Helper function to get a pill effect name from a PillEffect enum value.
  *
  * Example:
  * ```

package/dist/functions/revive.lua

@@ -6,7 +6,7 @@ local ____sprite = require("functions.sprite")
 local getFinalFrameOfAnimation = ____sprite.getFinalFrameOfAnimation
 local ____trinketGive = require("functions.trinketGive")
 local giveTrinketsBack = ____trinketGive.giveTrinketsBack
-local temporarilyRemoveTrinkets = ____trinketGive.temporarilyRemoveTrinkets
+local temporarilyRemoveTrinket = ____trinketGive.temporarilyRemoveTrinket
 function ____exports.willMysteriousPaperRevive(self, player)
     local game = Game()
     local gameFrameCount = game:GetFrameCount()
@@ -17,7 +17,7 @@ function ____exports.willMysteriousPaperRevive(self, player)
     return (frameOfDeath % 4) == 3
 end
 function ____exports.willPlayerRevive(self, player)
-    local trinketSituation = temporarilyRemoveTrinkets(nil, player, TrinketType.TRINKET_MYSTERIOUS_PAPER)
+    local trinketSituation = temporarilyRemoveTrinket(nil, player, TrinketType.TRINKET_MYSTERIOUS_PAPER)
     local willRevive = player:WillPlayerRevive() or ((trinketSituation ~= nil) and ____exports.willMysteriousPaperRevive(nil, player))
     giveTrinketsBack(nil, player, trinketSituation)
     return willRevive

package/dist/functions/transformations.d.ts

@@ -2,3 +2,13 @@
 /** Returns the number of items that a player has towards a particular transformation. */
 export declare function getPlayerNumTransformationCollectibles(player: EntityPlayer, playerForm: PlayerForm): int;
 export declare function getTransformationsForItem(collectibleType: CollectibleType | int): Set<PlayerForm>;
+/**
+ * Helper function to get a transformation name from a PlayerForm enum.
+ *
+ * Example:
+ * ```
+ * const transformationName = getTransformationName(PlayerForm.PLAYERFORM_LORD_OF_THE_FLIES);
+ * // transformationName is "Beelzebub"
+ * ```
+ */
+export declare function getTransformationName(transformation: PlayerForm): string;

package/dist/functions/transformations.lua

@@ -1,10 +1,12 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local ____transformationMap = require("maps.transformationMap")
-local ITEM_TO_TRANSFORMATION_MAP = ____transformationMap.ITEM_TO_TRANSFORMATION_MAP
-local TRANSFORMATIONS_NOT_BASED_ON_ITEMS = ____transformationMap.TRANSFORMATIONS_NOT_BASED_ON_ITEMS
-local TRANSFORMATION_TO_ITEMS_MAP = ____transformationMap.TRANSFORMATION_TO_ITEMS_MAP
+local ____transformationMaps = require("maps.transformationMaps")
+local ITEM_TO_TRANSFORMATION_MAP = ____transformationMaps.ITEM_TO_TRANSFORMATION_MAP
+local TRANSFORMATIONS_NOT_BASED_ON_ITEMS = ____transformationMaps.TRANSFORMATIONS_NOT_BASED_ON_ITEMS
+local TRANSFORMATION_TO_ITEMS_MAP = ____transformationMaps.TRANSFORMATION_TO_ITEMS_MAP
+local ____transformationNameMap = require("maps.transformationNameMap")
+local TRANSFORMATION_NAME_MAP = ____transformationNameMap.TRANSFORMATION_NAME_MAP
 local ____util = require("functions.util")
 local copySet = ____util.copySet
 function ____exports.getPlayerNumTransformationCollectibles(self, player, playerForm)
@@ -31,4 +33,9 @@ function ____exports.getTransformationsForItem(self, collectibleType)
     local transformations = ITEM_TO_TRANSFORMATION_MAP:get(collectibleType)
     return ((transformations == nil) and __TS__New(Set)) or copySet(nil, transformations)
 end
+function ____exports.getTransformationName(self, transformation)
+    local defaultName = "Unknown"
+    local transformationName = TRANSFORMATION_NAME_MAP:get(transformation)
+    return ((transformationName == nil) and defaultName) or transformationName
+end
 return ____exports

package/dist/functions/trinketGive.d.ts

@@ -1,21 +1,24 @@
 /// <reference types="isaac-typescript-definitions" />
-export interface TrinketSituation {
-    trinketTypeRemoved: TrinketType | int;
-    trinket1: TrinketType | int;
-    trinket2: TrinketType | int;
-    numSmeltedTrinkets: int;
-}
+import { TrinketSituation } from "../types/TrinketSituation";
 /**
- * Helper function to temporarily remove a trinket from the player. Use this in combination with the
- * `giveTrinketBack` function to take away and give back a trinket on the same frame. This function
- * correctly handles multiple trinket slots and ensures that all copies of the trinket are removed,
- * including smelted trinkets.
+ * Helper function to temporarily remove a specific kind of trinket from the player. Use this in
+ * combination with the `giveTrinketBack` function to take away and give back a trinket on the same
+ * frame. This function correctly handles multiple trinket slots and ensures that all copies of the
+ * trinket are removed, including smelted trinkets.
  *
  * Note that for simplicity, this function assumes that all smelted trinkets are non-golden.
  *
- * @returns Null if the player does not have the trinket, or TrinketSituation if they do.
+ * @returns Undefined if the player does not have the trinket, or TrinketSituation if they do.
  */
-export declare function temporarilyRemoveTrinkets(player: EntityPlayer, trinketType: TrinketType | int): TrinketSituation | undefined;
+export declare function temporarilyRemoveTrinket(player: EntityPlayer, trinketType: TrinketType | int): TrinketSituation | undefined;
+/**
+ * Helper function to temporarily removes a player's held trinkets, if any. This will not remove any
+ * smelted trinkets. Use this in combination with the `giveTrinketBack` function to take away and
+ * give back trinkets on the same frame.
+ *
+ * @returns Undefined if the player does not have any trinkets, or TrinketSituation if they do.
+ */
+export declare function temporarilyRemoveTrinkets(player: EntityPlayer): TrinketSituation | undefined;
 /**
  * Helper function to restore the player's trinkets back to the way they were before the
  * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were

package/dist/functions/trinketGive.lua

@@ -2,7 +2,7 @@
 local ____exports = {}
 local ____constants = require("constants")
 local GOLDEN_TRINKET_SHIFT = ____constants.GOLDEN_TRINKET_SHIFT
-function ____exports.temporarilyRemoveTrinkets(self, player, trinketType)
+function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
     if not player:HasTrinket(trinketType) then
         return nil
     end
@@ -24,6 +24,20 @@ function ____exports.temporarilyRemoveTrinkets(self, player, trinketType)
     end
     return {trinketTypeRemoved = trinketType, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = numSmeltedTrinkets}
 end
+function ____exports.temporarilyRemoveTrinkets(self, player)
+    local trinket1 = player:GetTrinket(0)
+    local trinket2 = player:GetTrinket(1)
+    if (trinket1 == TrinketType.TRINKET_NULL) and (trinket2 == TrinketType.TRINKET_NULL) then
+        return nil
+    end
+    if trinket1 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket1)
+    end
+    if trinket2 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket2)
+    end
+    return {trinketTypeRemoved = TrinketType.TRINKET_NULL, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = 0}
+end
 function ____exports.giveTrinketsBack(self, player, trinketSituation)
     if trinketSituation == nil then
         return

package/dist/functions/trinkets.d.ts

@@ -41,3 +41,14 @@ export declare function getTrinketName(trinketType: TrinketType | int): string;
  */
 export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
 export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean;
+/**
+ * Helper function to smelt a trinket. Before smelting, this function will automatically remove the
+ * trinkets that the player is holding, if any, and then give them back after the new trinket is
+ * smelted.
+ *
+ * @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.
+ */
+export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType | int, numTrinkets?: number): void;

package/dist/functions/trinkets.lua

@@ -7,6 +7,9 @@ local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
 local TRINKET_DESCRIPTION_MAP = ____trinketDescriptionMap.TRINKET_DESCRIPTION_MAP
 local ____trinketNameMap = require("maps.trinketNameMap")
 local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
+local ____trinketGive = require("functions.trinketGive")
+local giveTrinketsBack = ____trinketGive.giveTrinketsBack
+local temporarilyRemoveTrinkets = ____trinketGive.temporarilyRemoveTrinkets
 function ____exports.getMaxTrinketID(self)
     local itemConfig = Isaac.GetItemConfig()
     return itemConfig:GetTrinkets().Size - 1
@@ -86,4 +89,19 @@ end
 function ____exports.isGoldenTrinket(self, trinketType)
     return trinketType > GOLDEN_TRINKET_SHIFT
 end
+function ____exports.smeltTrinket(self, player, trinketType, numTrinkets)
+    if numTrinkets == nil then
+        numTrinkets = 1
+    end
+    local trinketSituation = temporarilyRemoveTrinkets(nil, player)
+    do
+        local i = 0
+        while i < numTrinkets do
+            player:AddTrinket(trinketType)
+            player:UseActiveItem(CollectibleType.COLLECTIBLE_SMELTER, false, false, true, false)
+            i = i + 1
+        end
+    end
+    giveTrinketsBack(nil, player, trinketSituation)
+end
 return ____exports

package/dist/index.d.ts

@@ -56,7 +56,8 @@ export * from "./maps/collectibleNameMap";
 export * from "./maps/gridEntityXMLMap";
 export * from "./maps/pillEffectNameMap";
 export * from "./maps/roomShapeToTopLeftWallGridIndexMap";
-export * from "./maps/transformationMap";
+export * from "./maps/transformationMaps";
+export * from "./maps/transformationNameMap";
 export * from "./maps/trinketNameMap";
 export * from "./sets/cards";
 export * from "./types/CallbackParametersCustom";
@@ -72,4 +73,5 @@ export * from "./types/PickingUpItem";
 export * from "./types/PlayerHealth";
 export * from "./types/PocketItemDescription";
 export * from "./types/PocketItemType";
+export * from "./types/TrinketSituation";
 export * from "./upgradeMod";

package/dist/index.lua

@@ -455,7 +455,15 @@ do
     end
 end
 do
-    local ____export = require("maps.transformationMap")
+    local ____export = require("maps.transformationMaps")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("maps.transformationNameMap")
     for ____exportKey, ____exportValue in pairs(____export) do
         if ____exportKey ~= "default" then
             ____exports[____exportKey] = ____exportValue

package/dist/maps/transformationMaps.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const TRANSFORMATION_TO_TAG_MAP: Map<PlayerForm, ItemConfigTag>;
+export declare const TRANSFORMATIONS_NOT_BASED_ON_ITEMS: Set<PlayerForm>;
+export declare const TRANSFORMATION_TO_ITEMS_MAP: Map<PlayerForm, Set<number>>;
+export declare const ITEM_TO_TRANSFORMATION_MAP: Map<number, Set<PlayerForm>>;

package/dist/maps/transformationMaps.lua

@@ -0,0 +1,56 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
+local ____exports = {}
+local initMaps
+local ____collectibles = require("functions.collectibles")
+local collectibleHasTag = ____collectibles.collectibleHasTag
+local getMaxCollectibleID = ____collectibles.getMaxCollectibleID
+function initMaps(self)
+    for ____, playerForm in __TS__Iterator(
+        ____exports.TRANSFORMATION_TO_TAG_MAP:keys()
+    ) do
+        ____exports.TRANSFORMATION_TO_ITEMS_MAP:set(
+            playerForm,
+            __TS__New(Set)
+        )
+    end
+    do
+        local collectibleType = 1
+        while collectibleType <= getMaxCollectibleID(nil) do
+            for ____, ____value in __TS__Iterator(
+                ____exports.TRANSFORMATION_TO_TAG_MAP:entries()
+            ) do
+                local playerForm
+                playerForm = ____value[1]
+                local tag
+                tag = ____value[2]
+                do
+                    if not collectibleHasTag(nil, collectibleType, tag) then
+                        goto __continue5
+                    end
+                    local items = ____exports.TRANSFORMATION_TO_ITEMS_MAP:get(playerForm)
+                    if items == nil then
+                        error(
+                            "Failed to get the items for transformation: " .. tostring(playerForm)
+                        )
+                    end
+                    items:add(collectibleType)
+                    local transformations = ____exports.ITEM_TO_TRANSFORMATION_MAP:get(collectibleType)
+                    if transformations == nil then
+                        transformations = __TS__New(Set)
+                        ____exports.ITEM_TO_TRANSFORMATION_MAP:set(collectibleType, transformations)
+                    end
+                    transformations:add(playerForm)
+                end
+                ::__continue5::
+            end
+            collectibleType = collectibleType + 1
+        end
+    end
+end
+____exports.TRANSFORMATION_TO_TAG_MAP = __TS__New(Map, {{PlayerForm.PLAYERFORM_GUPPY, 32}, {PlayerForm.PLAYERFORM_LORD_OF_THE_FLIES, 64}, {PlayerForm.PLAYERFORM_MUSHROOM, 256}, {PlayerForm.PLAYERFORM_ANGEL, 1024}, {PlayerForm.PLAYERFORM_BOB, 128}, {PlayerForm.PLAYERFORM_DRUGS, 2}, {PlayerForm.PLAYERFORM_MOM, 4}, {PlayerForm.PLAYERFORM_BABY, 512}, {PlayerForm.PLAYERFORM_EVIL_ANGEL, 2048}, {PlayerForm.PLAYERFORM_POOP, 4096}, {PlayerForm.PLAYERFORM_BOOK_WORM, 8192}, {PlayerForm.PLAYERFORM_SPIDERBABY, 16384}})
+____exports.TRANSFORMATIONS_NOT_BASED_ON_ITEMS = __TS__New(Set, {PlayerForm.PLAYERFORM_ADULTHOOD, PlayerForm.PLAYERFORM_STOMPY, PlayerForm.PLAYERFORM_FLIGHT})
+____exports.TRANSFORMATION_TO_ITEMS_MAP = __TS__New(Map)
+____exports.ITEM_TO_TRANSFORMATION_MAP = __TS__New(Map)
+initMaps(nil)
+return ____exports

package/dist/maps/transformationNameMap.d.ts

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

package/dist/maps/transformationNameMap.lua

@@ -0,0 +1,5 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
+local ____exports = {}
+____exports.TRANSFORMATION_NAME_MAP = __TS__New(Map, {{PlayerForm.PLAYERFORM_GUPPY, "Guppy"}, {PlayerForm.PLAYERFORM_LORD_OF_THE_FLIES, "Beelzebub"}, {PlayerForm.PLAYERFORM_MUSHROOM, "Fun Guy"}, {PlayerForm.PLAYERFORM_ANGEL, "Seraphim"}, {PlayerForm.PLAYERFORM_BOB, "Bob"}, {PlayerForm.PLAYERFORM_DRUGS, "Spun"}, {PlayerForm.PLAYERFORM_MOM, "Yes Mother?"}, {PlayerForm.PLAYERFORM_BABY, "Conjoined"}, {PlayerForm.PLAYERFORM_EVIL_ANGEL, "Leviathan"}, {PlayerForm.PLAYERFORM_POOP, "Oh Crap"}, {PlayerForm.PLAYERFORM_BOOK_WORM, "Bookworm"}, {PlayerForm.PLAYERFORM_ADULTHOOD, "Adult"}, {PlayerForm.PLAYERFORM_SPIDERBABY, "Spider Baby"}, {PlayerForm.PLAYERFORM_STOMPY, "Stompy"}, {PlayerForm.PLAYERFORM_FLIGHT, "Flight"}})
+return ____exports

package/dist/types/TrinketSituation.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="isaac-typescript-definitions" />
+export interface TrinketSituation {
+    trinketTypeRemoved: TrinketType | int;
+    trinket1: TrinketType | int;
+    trinket2: TrinketType | int;
+    numSmeltedTrinkets: int;
+}

package/dist/types/TrinketSituation.lua

@@ -0,0 +1,3 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+return ____exports

package/dist/upgradeMod.lua

@@ -54,6 +54,8 @@ local ____postSlotRenderBroken = require("callbacks.postSlotRenderBroken")
 local postSlotRenderBrokenCallbacksInit = ____postSlotRenderBroken.postSlotRenderBrokenCallbacksInit
 local ____postTearInitLate = require("callbacks.postTearInitLate")
 local postTearInitLateCallbackInit = ____postTearInitLate.postTearInitLateCallbackInit
+local ____postTearInitVeryLate = require("callbacks.postTearInitVeryLate")
+local postTearInitVeryLateCallbackInit = ____postTearInitVeryLate.postTearInitVeryLateCallbackInit
 local ____postTransformation = require("callbacks.postTransformation")
 local postTransformationCallbackInit = ____postTransformation.postTransformationCallbackInit
 local ____preNewLevel = require("callbacks.preNewLevel")
@@ -89,6 +91,7 @@ function initCustomCallbacks(self, mod)
     postPlayerReorderedCallbacksInit(nil, mod)
     postPlayerInitLateCallbackInit(nil, mod)
     postTearInitLateCallbackInit(nil, mod)
+    postTearInitVeryLateCallbackInit(nil, mod)
     postFamiliarInitLateCallbackInit(nil, mod)
     postBombInitLateCallbackInit(nil, mod)
     postPickupInitLateCallbackInit(nil, mod)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.540",
+  "version": "1.0.544",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,8 +25,8 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.302",
-    "isaacscript-lint": "^1.0.72",
+    "isaac-typescript-definitions": "^1.0.306",
+    "isaacscript-lint": "^1.0.73",
     "typedoc": "^0.22.10",
     "typescript": "4.4.4",
     "typescript-to-lua": "1.1.1"