isaacscript-common 2.3.0 → 3.0.0

package/src/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 {@link 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 {@link 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 {@link 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/src/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 & { __playerIndexBrand: void };

package/src/types/private/IsaacAPIClass.ts

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

package/src/types/private/SerializedIsaacAPIClass.ts

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

package/src/types/private/TSTLClass.ts

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

package/src/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;
-}

package/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "extends": "../../tsconfig.monorepo.json",
-
-  // https://www.typescriptlang.org/docs/handbook/compiler-options.html
-  "compilerOptions": {
-    "outDir": "../../dist/packages/isaacscript-common",
-
-    // Needed since TSTL does not work properly with the monorepo "rootDir" setting.
-    "rootDir": "./src",
-
-    // Needed since this is a library.
-    "declaration": true,
-
-    // Needed to hide internal functions from the auto-complete of end-users.
-    "stripInternal": true,
-
-    // Recommended as per TypeScriptToLua:
-    // https://typescripttolua.github.io/docs/getting-started/
-    "target": "ESNext",
-    "lib": ["ESNext"],
-    "moduleResolution": "Node",
-    // "types": ["dist/packages/isaac-typescript-definitions/index.d.ts"],
-    "types": ["isaac-typescript-definitions"],
-  },
-
-  // Nx will not include ".eslintrc.js" in the build output, so there is no need for a
-  // "tsconfig.eslint.rc" file.
-  "include": ["./src/**/*.ts", ".eslintrc.js"],
-
-  // TypeScriptToLua settings
-  "tstl": {
-    "luaTarget": "5.3",
-    "buildMode": "library",
-    "noHeader": true,
-    "luaPlugins": [
-      // A plugin to make enums safe from global variables.
-      {
-        "name": "../isaacscript-cli/file-templates/static/plugins/noExtendedEnums.ts",
-      },
-    ],
-  },
-}

package/typedoc.json

@@ -1,158 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "out": "../docs/docs/isaacscript-common",
-  "sort": ["source-order"],
-  "tsconfig": "tsconfig.json",
-  "readme": "website-root.md",
-  "treatWarningsAsErrors": true,
-  "validation": {
-    "invalidLink": true,
-    "notExported": true
-  },
-  "entryPoints": [
-    "src/cachedClasses.ts",
-    "src/classes/DefaultMap.ts",
-    "src/classes/ModUpgraded.ts",
-    "src/constants.ts",
-    "src/constantsFirstLast.ts",
-    "src/enums/HealthType.ts",
-    "src/enums/ModCallbackCustom.ts",
-    "src/enums/PocketItemType.ts",
-    "src/enums/SerializationType.ts",
-    "src/features/debugDisplay/exports.ts",
-    "src/features/deployJSONRoom.ts",
-    "src/features/disableInputs.ts",
-    "src/features/disableSound.ts",
-    "src/features/characterHealthConversion.ts",
-    "src/features/characterStats.ts",
-    "src/features/fadeInRemover.ts",
-    "src/features/fastReset.ts",
-    "src/features/extraConsoleCommands/init.ts",
-    "src/features/extraConsoleCommands/listCommands.ts",
-    "src/features/forgottenSwitch.ts",
-    "src/features/getCollectibleItemPoolType.ts",
-    "src/features/playerInventory.ts",
-    "src/features/ponyDetection.ts",
-    "src/features/preventCollectibleRotation.ts",
-    "src/features/runInNFrames.ts",
-    "src/features/saveDataManager/exports.ts",
-    "src/features/sirenHelpers.ts",
-    "src/features/taintedLazarusPlayers.ts",
-    "src/functions/array.ts",
-    "src/functions/benchmark.ts",
-    "src/functions/bitwise.ts",
-    "src/functions/boss.ts",
-    "src/functions/cacheFlag.ts",
-    "src/functions/cards.ts",
-    "src/functions/challenges.ts",
-    "src/functions/character.ts",
-    "src/functions/charge.ts",
-    "src/functions/chargeBar.ts",
-    "src/functions/collectibles.ts",
-    "src/functions/collectibleCacheFlag.ts",
-    "src/functions/collectibleSet.ts",
-    "src/functions/collectibleTag.ts",
-    "src/functions/color.ts",
-    "src/functions/debug.ts",
-    "src/functions/deepCopy.ts",
-    "src/functions/direction.ts",
-    "src/functions/doors.ts",
-    "src/functions/easing.ts",
-    "src/functions/eden.ts",
-    "src/functions/entity.ts",
-    "src/functions/entitySpecific.ts",
-    "src/functions/entityTypes.ts",
-    "src/functions/enums.ts",
-    "src/functions/familiars.ts",
-    "src/functions/flag.ts",
-    "src/functions/flying.ts",
-    "src/functions/globals.ts",
-    "src/functions/gridEntity.ts",
-    "src/functions/gridEntitySpecific.ts",
-    "src/functions/input.ts",
-    "src/functions/isaacAPIClass.ts",
-    "src/functions/jsonHelpers.ts",
-    "src/functions/jsonRoom.ts",
-    "src/functions/kColor.ts",
-    "src/functions/language.ts",
-    "src/functions/level.ts",
-    "src/functions/log.ts",
-    "src/functions/map.ts",
-    "src/functions/math.ts",
-    "src/functions/npc.ts",
-    "src/functions/pickups.ts",
-    "src/functions/pickupVariants.ts",
-    "src/functions/player.ts",
-    "src/functions/playerIndex.ts",
-    "src/functions/playerDataStructures.ts",
-    "src/functions/playerHealth.ts",
-    "src/functions/pills.ts",
-    "src/functions/pocketItems.ts",
-    "src/functions/positionVelocity.ts",
-    "src/functions/random.ts",
-    "src/functions/revive.ts",
-    "src/functions/rng.ts",
-    "src/functions/rooms.ts",
-    "src/functions/roomData.ts",
-    "src/functions/roomGrid.ts",
-    "src/functions/roomShape.ts",
-    "src/functions/run.ts",
-    "src/functions/seeds.ts",
-    "src/functions/serialization.ts",
-    "src/functions/set.ts",
-    "src/functions/sound.ts",
-    "src/functions/spawnCollectible.ts",
-    "src/functions/sprite.ts",
-    "src/functions/stage.ts",
-    "src/functions/string.ts",
-    "src/functions/table.ts",
-    "src/functions/tears.ts",
-    "src/functions/transformations.ts",
-    "src/functions/trinkets.ts",
-    "src/functions/trinketCacheFlag.ts",
-    "src/functions/trinketGive.ts",
-    "src/functions/tstlClass.ts",
-    "src/functions/ui.ts",
-    "src/functions/utils.ts",
-    "src/functions/vector.ts",
-    "src/interfaces/ChargeBarSprites.ts",
-    "src/interfaces/JSONDoor.ts",
-    "src/interfaces/JSONEntity.ts",
-    "src/interfaces/JSONRoom.ts",
-    "src/interfaces/JSONRooms.ts",
-    "src/interfaces/JSONSpawn.ts",
-    "src/interfaces/PlayerHealth.ts",
-    "src/interfaces/PocketItemDescription.ts",
-    "src/interfaces/SaveData.ts",
-    "src/interfaces/TrinketSituation.ts",
-    "src/maps/cardMap.ts",
-    "src/maps/characterMap.ts",
-    "src/maps/pillEffectMap.ts",
-    "src/maps/roomTypeMap.ts",
-    "src/types/AnyEntity.ts",
-    "src/types/CollectibleIndex.ts",
-    "src/types/PickingUpItem.ts",
-    "src/types/PlayerIndex.ts",
-    "src/upgradeMod.ts"
-  ],
-  "intentionallyNotExported": [
-    "AddCallbackParameterCustom",
-    "CopyColorReturn",
-    "CopyKColorReturn",
-    "CopyRNGReturn",
-    "CopyVectorReturn",
-    "FirstArg",
-    "SecondArg",
-    "SerializedColor",
-    "SerializedIsaacAPIClass",
-    "SerializedKColor",
-    "SerializedRNG",
-    "SerializedVector",
-    "IsaacAPIClass",
-    "TSTLClass"
-  ],
-  "plugin": "typedoc-plugin-markdown",
-  "hideBreadcrumbs": true,
-  "hideInPageTOC": true,
-  "hidePageTitle": true
-}

package/website-root.md

@@ -1,11 +0,0 @@
----
-sidebar_label: Introduction
-sidebar_position: 0
-custom_edit_url: null
----
-
-# `isaacscript-common`
-
-The `isaacscript-common` package contains extra goodies that you can easily use in your [IsaacScript](https://isaacscript.github.io/) mods. Think of it as an expanded standard library beyond what the official Isaac API offers.
-
-You can explore what `isaacscript-common` offers via the left navigation bar.