isaacscript-common 2.3.1 → 3.1.0

package/sets/bossSets.lua

@@ -37,6 +37,7 @@ local SatanVariant = ____isaac_2Dtypescript_2Ddefinitions.SatanVariant
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local WarVariant = ____isaac_2Dtypescript_2Ddefinitions.WarVariant
 local WidowVariant = ____isaac_2Dtypescript_2Ddefinitions.WidowVariant
+--- Contains just the bosses in Basement (not e.g. Burning Basement).
 local BASEMENT_BOSSES_SET = __TS__New(
     Set,
     {
@@ -56,6 +57,7 @@ local BASEMENT_BOSSES_SET = __TS__New(
         tostring(EntityType.BABY_PLUM) .. ".0"
     }
 )
+--- Contains just the bosses in Cellar (not e.g. Burning Basement).
 local CELLAR_BOSSES_SET = __TS__New(
     Set,
     {
@@ -72,6 +74,7 @@ local CELLAR_BOSSES_SET = __TS__New(
         tostring(EntityType.BABY_PLUM) .. ".0"
     }
 )
+--- Contains just the bosses in Burning Basement (not e.g. Cellar).
 local BURNING_BASEMENT_BOSSES_SET = __TS__New(
     Set,
     {
@@ -92,6 +95,7 @@ local BURNING_BASEMENT_BOSSES_SET = __TS__New(
         tostring(EntityType.BABY_PLUM) .. ".0"
     }
 )
+--- Contains just the bosses in Downpour (not e.g. Burning Basement).
 local DOWNPOUR_BOSSES_SET = __TS__New(
     Set,
     {
@@ -101,6 +105,7 @@ local DOWNPOUR_BOSSES_SET = __TS__New(
         tostring(EntityType.MIN_MIN) .. ".0"
     }
 )
+--- Contains just the bosses in Dross (not e.g. Burning Basement).
 local DROSS_BOSSES_SET = __TS__New(
     Set,
     {
@@ -129,6 +134,7 @@ __TS__SparseArrayPush(
     ____array_0,
     __TS__Spread(DROSS_BOSSES_SET:values())
 )
+--- The set of unique bosses for Basement, Cellar, and so on.
 local ALL_BASEMENT_BOSSES_SET = __TS__New(
     ____Set_1,
     {__TS__SparseArraySpread(____array_0)}
@@ -140,6 +146,7 @@ local BASEMENT_STAGE_TYPE_TO_BOSS_SET_MAP = __TS__New(Map, {
     {StageType.REPENTANCE, DOWNPOUR_BOSSES_SET},
     {StageType.REPENTANCE_B, DROSS_BOSSES_SET}
 })
+--- Contains just the bosses in Caves (not e.g. Flooded Caves).
 local CAVES_BOSSES_SET = __TS__New(
     Set,
     {
@@ -160,6 +167,7 @@ local CAVES_BOSSES_SET = __TS__New(
         tostring(EntityType.BUMBINO) .. ".0"
     }
 )
+--- Contains just the bosses in Catacombs (not e.g. Flooded Caves).
 local CATACOMBS_BOSSES_SET = __TS__New(
     Set,
     {
@@ -181,6 +189,7 @@ local CATACOMBS_BOSSES_SET = __TS__New(
         tostring(EntityType.BUMBINO) .. ".0"
     }
 )
+--- Contains just the bosses in Flooded Caves (not e.g. Catacombs).
 local FLOODED_CAVES_BOSSES_SET = __TS__New(
     Set,
     {
@@ -203,6 +212,7 @@ local FLOODED_CAVES_BOSSES_SET = __TS__New(
         tostring(EntityType.BUMBINO) .. ".0"
     }
 )
+--- Contains just the bosses in Mines (not e.g. Flooded Caves).
 local MINES_BOSSES_SET = __TS__New(
     Set,
     {
@@ -212,6 +222,7 @@ local MINES_BOSSES_SET = __TS__New(
         tostring(EntityType.GIDEON) .. ".0"
     }
 )
+--- Contains just the bosses in Ashpit (not e.g. Flooded Caves).
 local ASHPIT_BOSSES_SET = __TS__New(
     Set,
     {
@@ -240,6 +251,7 @@ __TS__SparseArrayPush(
     ____array_2,
     __TS__Spread(ASHPIT_BOSSES_SET:values())
 )
+--- The set of unique bosses for Caves, Catacombs, and so on.
 local ALL_CAVES_BOSSES_SET = __TS__New(
     ____Set_3,
     {__TS__SparseArraySpread(____array_2)}
@@ -251,6 +263,7 @@ local CAVES_STAGE_TYPE_TO_BOSS_SET_MAP = __TS__New(Map, {
     {StageType.REPENTANCE, MINES_BOSSES_SET},
     {StageType.REPENTANCE_B, ASHPIT_BOSSES_SET}
 })
+--- Contains just the bosses in Depths (not e.g. Dank Depths).
 local DEPTHS_BOSSES_SET = __TS__New(
     Set,
     {
@@ -268,6 +281,7 @@ local DEPTHS_BOSSES_SET = __TS__New(
         tostring(EntityType.REAP_CREEP) .. ".0"
     }
 )
+--- Contains just the bosses in Necropolis (not e.g. Dank Depths).
 local NECROPOLIS_BOSSES_SET = __TS__New(
     Set,
     {
@@ -284,6 +298,7 @@ local NECROPOLIS_BOSSES_SET = __TS__New(
         tostring(EntityType.SISTERS_VIS) .. ".0"
     }
 )
+--- Contains just the bosses in Dank Depths (not e.g. Necropolis).
 local DANK_DEPTHS_BOSSES_SET = __TS__New(
     Set,
     {
@@ -301,6 +316,7 @@ local DANK_DEPTHS_BOSSES_SET = __TS__New(
         tostring(EntityType.REAP_CREEP) .. ".0"
     }
 )
+--- Contains just the bosses in Mausoleum (not e.g. Dank Depths).
 local MAUSOLEUM_BOSSES_SET = __TS__New(
     Set,
     {
@@ -309,6 +325,7 @@ local MAUSOLEUM_BOSSES_SET = __TS__New(
         tostring(EntityType.HERETIC) .. ".0"
     }
 )
+--- Contains just the bosses in Gehenna (not e.g. Dank Depths).
 local GEHENNA_BOSSES_SET = __TS__New(
     Set,
     {
@@ -335,6 +352,7 @@ __TS__SparseArrayPush(
     ____array_4,
     __TS__Spread(GEHENNA_BOSSES_SET:values())
 )
+--- The set of unique bosses for Depths, Necropolis, and so on.
 local ALL_DEPTHS_BOSSES_SET = __TS__New(
     ____Set_5,
     {__TS__SparseArraySpread(____array_4)}
@@ -346,6 +364,7 @@ local DEPTHS_STAGE_TYPE_TO_BOSS_SET_MAP = __TS__New(Map, {
     {StageType.REPENTANCE, MAUSOLEUM_BOSSES_SET},
     {StageType.REPENTANCE_B, GEHENNA_BOSSES_SET}
 })
+--- Contains just the bosses in Womb (not e.g. Scarred Womb).
 local WOMB_BOSSES_SET = __TS__New(
     Set,
     {
@@ -363,6 +382,7 @@ local WOMB_BOSSES_SET = __TS__New(
         tostring(EntityType.MATRIARCH) .. ".0"
     }
 )
+--- Contains just the bosses in Utero (not e.g. Scarred Womb).
 local UTERO_BOSSES_SET = __TS__New(
     Set,
     {
@@ -379,6 +399,7 @@ local UTERO_BOSSES_SET = __TS__New(
         tostring(EntityType.HEADLESS_HORSEMAN) .. ".0"
     }
 )
+--- Contains just the bosses in Scarred Womb (not e.g. Utero).
 local SCARRED_WOMB_BOSSES_SET = __TS__New(
     Set,
     {
@@ -397,6 +418,7 @@ local SCARRED_WOMB_BOSSES_SET = __TS__New(
         tostring(EntityType.MATRIARCH) .. ".0"
     }
 )
+--- Contains just the bosses in Corpse (not e.g. Scarred Womb).
 local CORPSE_BOSSES_SET = __TS__New(
     Set,
     {
@@ -424,6 +446,7 @@ __TS__SparseArrayPush(
     ____array_6,
     __TS__Spread(GEHENNA_BOSSES_SET:values())
 )
+--- The set of unique bosses for Depths, Necropolis, and so on.
 local ALL_WOMB_BOSSES_SET = __TS__New(
     ____Set_7,
     {__TS__SparseArraySpread(____array_6)}

package/sets/charactersWithNoRedHeartsSet.lua

@@ -4,6 +4,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.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.
 ____exports.CHARACTERS_WITH_NO_RED_HEARTS_SET = __TS__New(Set, {
     PlayerType.BLUE_BABY,
     PlayerType.THE_LOST,

package/sets/charactersWithNoSoulHeartsSet.lua

@@ -4,6 +4,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+--- The set of characters where soul hearts will be automatically stripped away (e.g. Bethany). This
+-- includes The Lost and Tainted Lost.
 ____exports.CHARACTERS_WITH_NO_SOUL_HEARTS_SET = __TS__New(Set, {
     PlayerType.THE_LOST,
     PlayerType.KEEPER,

package/sets/lostStyleCharactersSet.lua

@@ -4,6 +4,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+--- This is the set of characters that look like The Lost and play the "LostDeath" animation when
+-- they die.
 ____exports.LOST_STYLE_CHARACTERS_SET = __TS__New(Set, {
     PlayerType.THE_LOST,
     PlayerType.THE_SOUL,

package/types/AnyEntity.d.ts

@@ -1,2 +1,12 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 export declare type AnyEntity = Entity | EntityBomb | EntityEffect | EntityFamiliar | EntityKnife | EntityLaser | EntityNPC | EntityPickup | EntityPlayer | EntityProjectile | EntityTear;

package/types/PickingUpItem.lua

@@ -7,20 +7,27 @@ local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local ItemType = ____isaac_2Dtypescript_2Ddefinitions.ItemType
 local DEFAULT_ITEM_TYPE = ItemType.NULL
 local DEFAULT_SUB_TYPE = CollectibleType.NULL
+---
+-- @internal
 function ____exports.newPickingUpItem(self)
     return {itemType = DEFAULT_ITEM_TYPE, subType = DEFAULT_SUB_TYPE}
 end
+---
+-- @internal
 function ____exports.resetPickingUpItem(self, pickingUpItem)
     pickingUpItem.itemType = DEFAULT_ITEM_TYPE
     pickingUpItem.subType = DEFAULT_SUB_TYPE
 end
 local COLLECTIBLE_ITEM_TYPES = __TS__New(Set, {ItemType.PASSIVE, ItemType.ACTIVE, ItemType.FAMILIAR})
+--- Helper function to narrow the type of `PickingUpItem`.
 function ____exports.pickingUpItemIsNull(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.NULL
 end
+--- Helper function to narrow the type of `PickingUpItem`.
 function ____exports.pickingUpItemIsCollectible(self, pickingUpItem)
     return COLLECTIBLE_ITEM_TYPES:has(pickingUpItem.itemType)
 end
+--- Helper function to narrow the type of `PickingUpItem`.
 function ____exports.pickingUpItemIsTrinket(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.TRINKET
 end

package/upgradeMod.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="isaac-typescript-definitions" />
 import { ModUpgraded } from "./classes/ModUpgraded";
 /**
- * Use this function to enable the custom callbacks and other optional features provided by
- * `isaacscript-common`.
+ * Use this function to enable the {@link ModCallbackCustom custom callbacks} and other optional
+ * features provided by `isaacscript-common`.
  *
  * For example:
  *
@@ -10,10 +10,10 @@ import { ModUpgraded } from "./classes/ModUpgraded";
  * const modVanilla = RegisterMod("My Mod", 1);
  * const mod = upgradeMod(modVanilla);
  *
- * // Subscribe to vanilla callbacks
+ * // Subscribe to vanilla callbacks.
  * mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
  *
- * // Subscribe to custom callbacks
+ * // Subscribe to custom callbacks.
  * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
  * ```
  *

package/upgradeMod.lua

@@ -17,6 +17,24 @@ local initFeaturesMajor = ____initFeatures.initFeaturesMajor
 local initFeaturesMinor = ____initFeatures.initFeaturesMinor
 local ____patchErrorFunctions = require("patchErrorFunctions")
 local patchErrorFunction = ____patchErrorFunctions.patchErrorFunction
+--- Use this function to enable the {@link ModCallbackCustomcustom callbacks} and other optional
+-- features provided by `isaacscript-common`.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const modVanilla = RegisterMod("My Mod", 1);
+-- const mod = upgradeMod(modVanilla);
+-- 
+-- // Subscribe to vanilla callbacks.
+-- mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
+-- 
+-- // Subscribe to custom callbacks.
+-- mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
+-- ```
+-- 
+-- @param modVanilla The mod object returned by the `RegisterMod` function.
+-- @returns The upgraded mod object.
 function ____exports.upgradeMod(self, modVanilla)
     patchErrorFunction(nil)
     local mod = __TS__New(ModUpgraded, modVanilla)