isaacscript-common 4.0.2 → 4.0.5

package/types/CollectibleIndex.ts

@@ -1,16 +0,0 @@
-/**
- * CollectibleIndex is a specific type of string; see the documentation for the
- * `getCollectibleIndex` function. Mods can signify that data structures handle collectibles by
- * using this type.
- *
- * For example:
- *
- * ```ts
- * const collectiblesNameMap = new Map<CollectibleIndex, string>();
- * ```
- *
- * This type is branded for extra type safety.
- */
-export type CollectibleIndex = string & {
-  readonly __collectibleIndexBrand: unique symbol;
-};

package/types/PickingUpItem.ts

@@ -1,89 +0,0 @@
-/* eslint-disable sort-exports/sort-exports */
-
-/**
- * This is the type that is fed to the `PRE_ITEM_PICKUP` and `POST_ITEM_PICKUP` custom callbacks.
- *
- * @module
- */
-
-import {
-  CollectibleType,
-  ItemType,
-  TrinketType,
-} from "isaac-typescript-definitions";
-
-export type PickingUpItem =
-  | PickingUpItemNull
-  | PickingUpItemCollectible
-  | PickingUpItemTrinket;
-
-/** Part of `PickingUpItem`. */
-export interface PickingUpItemNull {
-  /** Needed so that we can distinguish between picking up a collectible and a trinket. */
-  itemType: ItemType.NULL;
-
-  /** Equal to either the collectible type, the trinket type, or 0. */
-  subType: 0;
-}
-
-/** Part of `PickingUpItem`. */
-export interface PickingUpItemCollectible {
-  /** Needed so that we can distinguish between picking up a collectible and a trinket. */
-  itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR;
-
-  /** Equal to either the collectible type, the trinket type, or 0. */
-  subType: CollectibleType;
-}
-
-/** Part of `PickingUpItem`. */
-export interface PickingUpItemTrinket {
-  /** Needed so that we can distinguish between picking up a collectible and a trinket. */
-  itemType: ItemType.TRINKET;
-
-  /** Equal to either the collectible type, the trinket type, or 0. */
-  subType: TrinketType;
-}
-
-const DEFAULT_ITEM_TYPE = ItemType.NULL;
-const DEFAULT_SUB_TYPE = CollectibleType.NULL;
-
-/** @internal */
-export function newPickingUpItem(): PickingUpItem {
-  return {
-    itemType: DEFAULT_ITEM_TYPE,
-    subType: DEFAULT_SUB_TYPE,
-  };
-}
-
-/** @internal */
-export function resetPickingUpItem(pickingUpItem: PickingUpItem): void {
-  pickingUpItem.itemType = DEFAULT_ITEM_TYPE;
-  pickingUpItem.subType = DEFAULT_SUB_TYPE;
-}
-
-const COLLECTIBLE_ITEM_TYPES: ReadonlySet<ItemType> = new Set([
-  ItemType.PASSIVE, // 1
-  ItemType.ACTIVE, // 3
-  ItemType.FAMILIAR, // 4
-]);
-
-/** Helper function to narrow the type of `PickingUpItem`. */
-export function pickingUpItemIsNull(
-  pickingUpItem: PickingUpItem,
-): pickingUpItem is PickingUpItemTrinket {
-  return pickingUpItem.itemType === ItemType.NULL;
-}
-
-/** Helper function to narrow the type of `PickingUpItem`. */
-export function pickingUpItemIsCollectible(
-  pickingUpItem: PickingUpItem,
-): pickingUpItem is PickingUpItemCollectible {
-  return COLLECTIBLE_ITEM_TYPES.has(pickingUpItem.itemType);
-}
-
-/** Helper function to narrow the type of `PickingUpItem`. */
-export function pickingUpItemIsTrinket(
-  pickingUpItem: PickingUpItem,
-): pickingUpItem is PickingUpItemTrinket {
-  return pickingUpItem.itemType === ItemType.TRINKET;
-}

package/types/PlayerIndex.ts

@@ -1,13 +0,0 @@
-/**
- * PlayerIndex is a specific type of string; see the documentation for the `getPlayerIndex`
- * function. Mods can signify that data structures handle `EntityPlayer` by using this type.
- *
- * For example:
- *
- * ```ts
- * const playersNameMap = new Map<PlayerIndex, string>();
- * ```
- *
- * This type is branded for extra type safety.
- */
-export type PlayerIndex = int & { readonly __playerIndexBrand: unique symbol };

package/types/private/IsaacAPIClass.ts

@@ -1,3 +0,0 @@
-export type IsaacAPIClass = LuaTable<string, unknown> & {
-  readonly __isaacAPIClassBrand: unique symbol;
-};

package/types/private/SerializedIsaacAPIClass.ts

@@ -1,3 +0,0 @@
-export type SerializedIsaacAPIClass = LuaTable<string, unknown> & {
-  readonly __serializedIsaacAPIClassBrand: unique symbol;
-};

package/types/private/TSTLClass.ts

@@ -1,3 +0,0 @@
-export type TSTLClass = LuaTable<AnyNotNil, unknown> & {
-  readonly __tstlClassBrand: unique symbol;
-};

package/upgradeMod.ts

@@ -1,55 +0,0 @@
-import { postNewRoomEarlyCallbackInit } from "./callbacks/postNewRoomEarly";
-import { ModUpgraded } from "./classes/ModUpgraded";
-import { saveDataManagerInit } from "./features/saveDataManager/main";
-import {
-  areFeaturesInitialized,
-  setFeaturesInitialized,
-} from "./featuresInitialized";
-import { initCustomCallbacks } from "./initCustomCallbacks";
-import { initFeaturesMajor, initFeaturesMinor } from "./initFeatures";
-import { patchErrorFunction } from "./patchErrorFunctions";
-
-/**
- * Use this function to enable the custom 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.
- */
-export function upgradeMod(modVanilla: Mod): ModUpgraded {
-  patchErrorFunction();
-
-  const mod = new ModUpgraded(modVanilla);
-
-  if (!areFeaturesInitialized()) {
-    setFeaturesInitialized();
-
-    // We initialize the PostNewRoomEarly callback first since it is used by the save data manager.
-    postNewRoomEarlyCallbackInit(mod);
-
-    // We initialized the save data manager second since it is used by the other custom callbacks
-    // and features.
-    saveDataManagerInit(mod);
-
-    // We initialize custom callbacks next since some features use custom callbacks.
-    initCustomCallbacks(mod);
-
-    initFeaturesMajor(mod);
-    initFeaturesMinor(mod);
-  }
-
-  return mod;
-}