isaacscript-common 14.2.0 → 15.0.0

package/src/functions/transformations.ts

@@ -5,10 +5,8 @@ import {
 } from "isaac-typescript-definitions";
 import { TRANSFORMATION_NAMES } from "../objects/transformationNames";
 import { getCollectibleTags } from "./collectibles";
-import { getCollectibleTypesWithTag } from "./collectibleTag";
 import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";
-import { getPlayerCollectibleCount } from "./players";
 
 const TRANSFORMATION_TO_TAG_MAP: ReadonlyMap<PlayerForm, ItemConfigTag> =
   new Map([
@@ -35,38 +33,6 @@ const TRANSFORMATIONS_THAT_GRANT_FLYING: ReadonlySet<PlayerForm> = new Set([
   PlayerForm.LEVIATHAN, // 8
 ]);
 
-/**
- * Helper function to get all of the collectible types in the game that count towards a particular
- * transformation.
- *
- * For example, to get all of the collectible types that count towards Guppy:
- *
- * ```ts
- * const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
- * ```
- */
-export function getCollectibleTypesForTransformation(
-  playerForm: PlayerForm,
-): ReadonlySet<CollectibleType> {
-  const itemConfigTag = TRANSFORMATION_TO_TAG_MAP.get(playerForm);
-  if (itemConfigTag === undefined) {
-    error(
-      `Failed to get the collectible types for the transformation of ${playerForm} because that transformation is not based on collectibles.`,
-    );
-  }
-
-  return getCollectibleTypesWithTag(itemConfigTag);
-}
-
-/** Returns the number of items that a player has towards a particular transformation. */
-export function getPlayerNumCollectiblesForTransformation(
-  player: EntityPlayer,
-  playerForm: PlayerForm,
-): int {
-  const collectibleTypes = getCollectibleTypesForTransformation(playerForm);
-  return getPlayerCollectibleCount(player, ...collectibleTypes.values());
-}
-
 /** Returns a set of the player's current transformations. */
 export function getPlayerTransformations(
   player: EntityPlayer,
@@ -95,6 +61,10 @@ export function getTransformationName(playerForm: PlayerForm): string {
   return TRANSFORMATION_NAMES[playerForm];
 }
 
+/**
+ * Returns a set containing all of the transformations that the given collectible types contribute
+ * towards.
+ */
 export function getTransformationsForCollectibleType(
   collectibleType: CollectibleType,
 ): Set<PlayerForm> {

package/src/functions/trinkets.ts

@@ -1,4 +1,5 @@
 import {
+  CacheFlag,
   PlayerType,
   TrinketSlot,
   TrinketType,
@@ -18,6 +19,7 @@ import {
   TRINKET_TYPE_TO_NAME_MAP,
 } from "../maps/trinketTypeToNameMap";
 import { getEntityID } from "./entities";
+import { hasFlag } from "./flag";
 import { isTrinket } from "./pickupVariants";
 import { isCharacter } from "./players";
 import { clearSprite } from "./sprites";
@@ -222,3 +224,16 @@ export function setTrinketSprite(
     sprite.LoadGraphics();
   }
 }
+
+/** Helper function to check in the item config if a given trinket has a given cache flag. */
+export function trinketHasCacheFlag(
+  trinketType: TrinketType,
+  cacheFlag: CacheFlag,
+): boolean {
+  const itemConfigItem = itemConfig.GetTrinket(trinketType);
+  if (itemConfigItem === undefined) {
+    return false;
+  }
+
+  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
+}

package/src/index.ts

@@ -1,6 +1,6 @@
 export * from "./classes/DefaultMap";
 export * from "./classes/ModFeature";
-export * from "./classes/ModUpgraded";
+export * from "./classes/ModUpgradedBase";
 export * from "./core/cachedClasses";
 export * from "./core/constants";
 export * from "./core/constantsFirstLast";
@@ -11,7 +11,6 @@ export * from "./enums/HealthType";
 export * from "./enums/ISCFeature";
 export * from "./enums/LadderSubTypeCustom";
 export * from "./enums/ModCallbackCustom";
-export * from "./enums/ModCallbackCustom2";
 export * from "./enums/PocketItemType";
 export * from "./enums/RockAltType";
 export * from "./enums/SaveDataKey";
@@ -19,38 +18,6 @@ export * from "./enums/SerializationBrand";
 export * from "./enums/SerializationType";
 export * from "./enums/SlotDestructionType";
 export * from "./enums/StatType";
-export * from "./features/characterHealthConversion";
-export * from "./features/characterStats";
-export * from "./features/collectibleItemPoolType";
-export * from "./features/customGridEntity";
-export * from "./features/customHotkeys";
-export * from "./features/customItemPool";
-export * from "./features/customPickup";
-export * from "./features/customStage/exports";
-export * from "./features/customTrapdoor/exports";
-export * from "./features/debugDisplay/exports";
-export * from "./features/deployJSONRoom";
-export * from "./features/disableAllSound";
-export * from "./features/disableInputs";
-export * from "./features/extraConsoleCommands/exports";
-export * from "./features/fadeInRemover";
-export * from "./features/fastReset";
-export * from "./features/firstLast";
-export * from "./features/forgottenSwitch";
-export * from "./features/pause";
-export * from "./features/persistentEntities";
-export * from "./features/pickupIndex";
-export * from "./features/playerInventory";
-export * from "./features/ponyDetection";
-export * from "./features/preventChildEntities";
-export * from "./features/preventCollectibleRotation";
-export * from "./features/roomClearFrame";
-export * from "./features/roomHistory";
-export * from "./features/runInNFrames";
-export * from "./features/saveDataManager/exports";
-export * from "./features/sirenHelpers";
-export * from "./features/stageHistory";
-export * from "./features/taintedLazarusPlayers";
 export * from "./functions/ambush";
 export * from "./functions/array";
 export * from "./functions/arrayLua";
@@ -64,9 +31,7 @@ export * from "./functions/challenges";
 export * from "./functions/characters";
 export * from "./functions/charge";
 export * from "./functions/chargeBar";
-export * from "./functions/collectibleCacheFlag";
 export * from "./functions/collectibles";
-export * from "./functions/collectibleSet";
 export * from "./functions/collectibleTag";
 export * from "./functions/color";
 export * from "./functions/curses";
@@ -74,12 +39,10 @@ export * from "./functions/debugFunctions";
 export * from "./functions/decorators";
 export * from "./functions/deepCopy";
 export * from "./functions/deepCopyTests";
-export * from "./functions/dev";
 export * from "./functions/dimensions";
 export * from "./functions/direction";
 export * from "./functions/doors";
 export * from "./functions/easing";
-export * from "./functions/eden";
 export * from "./functions/effects";
 export * from "./functions/emptyRoom";
 export * from "./functions/entities";
@@ -88,7 +51,6 @@ export * from "./functions/entityTypes";
 export * from "./functions/enums";
 export * from "./functions/familiars";
 export * from "./functions/flag";
-export * from "./functions/flying";
 export * from "./functions/globals";
 export * from "./functions/gridEntities";
 export * from "./functions/gridEntitiesSpecific";
@@ -97,7 +59,6 @@ export * from "./functions/hex";
 export * from "./functions/initArray";
 export * from "./functions/input";
 export * from "./functions/isaacAPIClass";
-export * from "./functions/itemPool";
 export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
 export * from "./functions/kColor";
@@ -129,7 +90,6 @@ export * from "./functions/positionVelocity";
 export * from "./functions/pressurePlate";
 export * from "./functions/projectiles";
 export * from "./functions/random";
-export * from "./functions/reorderedCallbacks";
 export * from "./functions/revive";
 export * from "./functions/rng";
 export * from "./functions/rockAlt";
@@ -140,7 +100,6 @@ export * from "./functions/roomShape";
 export * from "./functions/roomShapeWalls";
 export * from "./functions/roomTransition";
 export * from "./functions/run";
-export * from "./functions/saveFile";
 export * from "./functions/seeds";
 export * from "./functions/serialization";
 export * from "./functions/set";
@@ -152,10 +111,8 @@ export * from "./functions/string";
 export * from "./functions/table";
 export * from "./functions/tears";
 export * from "./functions/transformations";
-export * from "./functions/trinketCacheFlag";
 export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
-export * from "./functions/trinketSet";
 export * from "./functions/tstlClass";
 export * from "./functions/types";
 export * from "./functions/ui";
@@ -177,26 +134,34 @@ export * from "./maps/cardNameToTypeMap";
 export * from "./maps/characterNameToTypeMap";
 export * from "./maps/pillNameToEffectMap";
 export * from "./maps/roomNameToTypeMap";
+export * from "./maps/transformationNameToPlayerFormMap";
 export * from "./objects/colors";
 export * from "./objects/kColors";
 export * from "./types/AllButFirst";
 export * from "./types/AllButLast";
+export * from "./types/AnyClass";
 export * from "./types/AnyEntity";
 export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
 export * from "./types/CollectibleIndex";
-export * from "./types/Constructor";
+export * from "./types/ConversionHeartSubType";
 export * from "./types/FunctionTuple";
 export * from "./types/HasAllEnumKeys";
 export * from "./types/HasFunction";
 export * from "./types/Immutable";
 export * from "./types/LowercaseKeys";
+export * from "./types/ModUpgraded";
 export * from "./types/PickingUpItem";
 export * from "./types/PickupIndex";
 export * from "./types/PlayerIndex";
 export * from "./types/PossibleStatType";
+export * from "./types/PublicInterface";
 export * from "./types/StartsWithLowercase";
 export * from "./types/StartsWithUppercase";
 export * from "./types/TSTLClass";
+export * from "./types/TupleToIntersection";
+export * from "./types/TupleToUnion";
+export * from "./types/UnionToIntersection";
 export * from "./types/UppercaseKeys";
 export * from "./types/WeightedArray";
+export * from "./types/Writable";

package/src/interfaces/CustomStageTSConfig.ts

@@ -560,8 +560,8 @@ export interface CustomStageBossPoolEntry {
 }
 
 /**
- * An object that represents a custom stage. The "metadata.lua" file contains an array of these
- * objects. Besides the room metadata, the data is the same as what is specified inside the
+ * An object that represents a custom stage. The "customStageMetadata.lua" file contains an array of
+ * these objects. Besides the room metadata, the data is the same as what is specified inside the
  * "tsconfig.json" file.
  *
  * The `CustomStage` interface extends this, adding more data.
@@ -575,14 +575,11 @@ interface CustomStageLuaUnsafe extends CustomStageTSConfig {
   roomsMetadata: CustomStageRoomMetadata[];
 }
 
-/** @internal */
 export type CustomStageLua = Immutable<CustomStageLuaUnsafe>;
 
 /**
  * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
  * each room.
- *
- * @internal
  */
 export interface CustomStageRoomMetadata {
   type: number;

package/src/interfaces/RoomDescription.ts

@@ -1,4 +1,5 @@
 import {
+  Dimension,
   LevelStage,
   RoomType,
   StageID,
@@ -10,6 +11,7 @@ export interface RoomDescription {
   stage: LevelStage;
   stageType: StageType;
   stageID: StageID;
+  dimension: Dimension;
   roomType: RoomType;
   roomVariant: int;
   roomSubType: int;