isaacscript-common 6.22.0 → 6.22.1

package/src/features/extraConsoleCommands/listCommands.ts

@@ -39,8 +39,8 @@ import {
   SoundEffect,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game, sfxManager } from "../../cachedClasses";
-import { MAX_LEVEL_GRID_INDEX } from "../../constants";
+import { game, sfxManager } from "../../core/cachedClasses";
+import { MAX_LEVEL_GRID_INDEX } from "../../core/constants";
 import {
   FIRST_CARD,
   FIRST_CHARACTER,
@@ -52,7 +52,7 @@ import {
   LAST_ROOM_TYPE,
   LAST_STAGE,
   LAST_VANILLA_CHARACTER,
-} from "../../constantsFirstLast";
+} from "../../core/constantsFirstLast";
 import { HealthType } from "../../enums/HealthType";
 import { getCardName } from "../../functions/cards";
 import { getCharacterName } from "../../functions/characters";

package/src/features/fadeInRemover.ts

@@ -1,5 +1,5 @@
 import { ModCallback } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { saveDataManager } from "./saveDataManager/exports";
 
@@ -14,7 +14,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function fadeInRemoverInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v, () => false);
 

package/src/features/fastReset.ts

@@ -1,5 +1,5 @@
 import { ButtonAction, ModCallback } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import {
   isActionTriggeredOnAnyInput,
@@ -11,7 +11,6 @@ const FEATURE_NAME = "fastReset";
 
 let enabled = false;
 
-/** @internal */
 export function fastResetInit(mod: Mod): void {
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
 }

package/src/features/forgottenSwitch.ts

@@ -14,7 +14,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function forgottenSwitchInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/index.ts

@@ -0,0 +1,59 @@
+export {
+  ConversionHeartSubType,
+  registerCharacterHealthConversion,
+} from "./characterHealthConversion";
+export { registerCharacterStats } from "./characterStats";
+export { getCollectibleItemPoolType } from "./collectibleItemPoolType";
+export { initCustomDoor, spawnCustomDoor } from "./customDoor";
+export {
+  removeCustomGridEntity as removeCustomGrid,
+  spawnCustomGridEntity as spawnCustomGrid,
+} from "./customGridEntity";
+export * from "./customStage/exports";
+export * from "./customTrapdoor/exports";
+export * from "./debugDisplay/exports";
+export {
+  deployJSONRoom,
+  deployRandomJSONRoom,
+  emptyRoom,
+} from "./deployJSONRoom";
+export { disableAllSound, enableAllSound } from "./disableAllSound";
+export {
+  disableAllInputs,
+  disableAllInputsExceptFor,
+  disableMovementInputs,
+  disableShootingInputs,
+  enableAllInputs,
+  enableAllInputsExceptFor,
+} from "./disableInputs";
+export * from "./extraConsoleCommands/exports";
+export { removeFadeIn, restoreFadeIn } from "./fadeInRemover";
+export { disableFastReset, enableFastReset } from "./fastReset";
+export { forgottenSwitch } from "./forgottenSwitch";
+export { pause, unpause } from "./pause";
+export {
+  removePersistentEntity,
+  spawnPersistentEntity,
+} from "./persistentEntities";
+export * from "./pickupIndex";
+export { getPlayerInventory } from "./playerInventory";
+export { anyPlayerUsingPony, isPlayerUsingPony } from "./ponyDetection";
+export { preventCollectibleRotation } from "./preventCollectibleRotation";
+export { registerHotkey, unregisterHotkey } from "./registerHotkey";
+export { getRoomClearGameFrame, getRoomClearRoomFrame } from "./roomClearFrame";
+export * from "./roomHistory";
+export {
+  runInNGameFrames,
+  runInNRenderFrames,
+  runNextGameFrame,
+  runNextRenderFrame,
+  setIntervalGameFrames,
+  setIntervalRenderFrames,
+} from "./runInNFrames";
+export * from "./saveDataManager/exports";
+export {
+  hasSirenStolenFamiliar,
+  setFamiliarNoSirenSteal,
+} from "./sirenHelpers";
+export { getStageHistory, hasVisitedStage } from "./stageHistory";
+export { getTaintedLazarusSubPlayer } from "./taintedLazarusPlayers";

package/src/features/indexTypeDoc.ts

@@ -0,0 +1,29 @@
+export * as CharacterHealthConversion from "./characterHealthConversion";
+export * as CharacterStats from "./characterStats";
+export * as CollectibleItemPoolType from "./collectibleItemPoolType";
+export * as CustomDoor from "./customDoor";
+export * as CustomGridEntity from "./customGridEntity";
+export * as CustomStage from "./customStage/exports";
+export * as CustomTrapdoor from "./customTrapdoor/exports";
+export * as DebugDisplay from "./debugDisplay/exports";
+export * as DeployJSONRoom from "./deployJSONRoom";
+export * as DisableAllSound from "./disableAllSound";
+export * as DisableInputs from "./disableInputs";
+export * as ExtraConsoleCommands from "./extraConsoleCommands/exports";
+export * as FadeInRemover from "./fadeInRemover";
+export * as FastReset from "./fastReset";
+export * as ForgottenSwitch from "./forgottenSwitch";
+export * as Pause from "./pause";
+export * as PersistentEntities from "./persistentEntities";
+export * as PickupIndex from "./pickupIndex";
+export * as PlayerInventory from "./playerInventory";
+export * as PonyDetection from "./ponyDetection";
+export * as PreventCollectibleRotation from "./preventCollectibleRotation";
+export * as RegisterHotkey from "./registerHotkey";
+export * as RoomClearFrame from "./roomClearFrame";
+export * as RoomHistory from "./roomHistory";
+export * as RunInNFrames from "./runInNFrames";
+export * as SaveDataManager from "./saveDataManager/exports";
+export * as SirenHelpers from "./sirenHelpers";
+export * as StageHistory from "./stageHistory";
+export * as TaintedLazarusPlayers from "./taintedLazarusPlayers";

package/src/features/pause.ts

@@ -4,7 +4,7 @@ import {
   InputHook,
   ModCallback,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 import {
   getProjectiles,
   getTears,
@@ -37,7 +37,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function pauseInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/persistentEntities.ts

@@ -43,7 +43,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function persistentEntitiesInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/pickupIndex.ts

@@ -3,9 +3,9 @@ import {
   ModCallback,
   RoomType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
 import { DefaultMap } from "../classes/DefaultMap";
 import { ModUpgraded } from "../classes/ModUpgraded";
+import { game } from "../core/cachedClasses";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { getEntityID } from "../functions/entities";

package/src/features/playerInventory.ts

@@ -45,7 +45,6 @@ function resetInventory(player: EntityPlayer) {
   mapSetPlayer(v.run.playersInventory, player, inventory);
 }
 
-/** @internal */
 export function playerInventoryInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/ponyDetection.ts

@@ -33,7 +33,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function ponyDetectionInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/preventCollectibleRotation.ts

@@ -7,7 +7,7 @@ import {
   ModCallback,
   PickupVariant,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { setCollectibleSubType } from "../functions/collectibles";
 import { getEntityID } from "../functions/entities";
@@ -32,7 +32,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function preventCollectibleRotationInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/registerHotkey.ts

@@ -23,7 +23,6 @@ const dynamicHotkeyFunctionMap = new Map<
 
 const keyPressedMap = new DefaultMap<Keyboard, boolean>(false);
 
-/** @internal */
 export function registerHotkeyInit(mod: Mod): void {
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
 }

package/src/features/roomClearFrame.ts

@@ -1,5 +1,5 @@
-import { game } from "../cachedClasses";
 import { ModUpgraded } from "../classes/ModUpgraded";
+import { game } from "../core/cachedClasses";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { saveDataManager } from "./saveDataManager/exports";
@@ -13,7 +13,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function roomClearFrameInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/roomHistory.ts

@@ -1,5 +1,5 @@
-import { game } from "../cachedClasses";
 import { ModUpgraded } from "../classes/ModUpgraded";
+import { game } from "../core/cachedClasses";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { getLastElement } from "../functions/array";
@@ -23,7 +23,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function roomHistoryInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/runInNFrames.ts

@@ -1,5 +1,5 @@
 import { ModCallback } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { arrayRemoveInPlace } from "../functions/array";
 import { saveDataManager } from "./saveDataManager/exports";
@@ -30,7 +30,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function runInNFramesInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v, () => false); // Functions are not serializable.
 

package/src/features/runNextRoom.ts

@@ -12,7 +12,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function runNextRoomInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v, () => false); // Functions are not serializable.
 

package/src/features/saveDataManager/main.ts

@@ -1,6 +1,6 @@
 import { ModCallback } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
 import { ModUpgraded } from "../../classes/ModUpgraded";
+import { game } from "../../core/cachedClasses";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { SaveDataKey } from "../../enums/private/SaveDataKey";
 import { SerializationType } from "../../enums/SerializationType";
@@ -29,7 +29,6 @@ const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey> = new Set([
 let mod: ModUpgraded | null = null;
 let loadedDataOnThisRun = false;
 
-/** @internal */
 export function saveDataManagerInit(incomingMod: ModUpgraded): void {
   mod = incomingMod;
 
@@ -176,7 +175,6 @@ function clearAndCopyAllElements(
   }
 }
 
-/** @internal */
 export function forceSaveDataManagerSave(): void {
   if (mod === null) {
     return;
@@ -185,7 +183,6 @@ export function forceSaveDataManagerSave(): void {
   saveToDisk(mod, saveDataMap, saveDataConditionalFuncMap);
 }
 
-/** @internal */
 export function forceSaveDataManagerLoad(): void {
   if (mod === null) {
     return;

package/src/features/sirenHelpers.ts

@@ -17,7 +17,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function sirenHelpersInit(mod: Mod): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/stageHistory.ts

@@ -1,6 +1,6 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
 import { ModUpgraded } from "../classes/ModUpgraded";
+import { game } from "../core/cachedClasses";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { saveDataManager } from "./saveDataManager/exports";
@@ -13,7 +13,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function stageHistoryInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 

package/src/features/taintedLazarusPlayers.ts

@@ -30,7 +30,6 @@ const v = {
   },
 };
 
-/** @internal */
 export function taintedLazarusPlayersInit(mod: ModUpgraded): void {
   // `EntityPtr` is not serializable, so we cannot save data. However, this is inconsequential,
   // since the `POST_PLAYER_INIT` callback will fire when a run is continued, which will repopulate

package/src/featuresInitialized.ts

@@ -1,11 +1,9 @@
 let featuresInitialized = false;
 
-/** @internal */
 export function areFeaturesInitialized(): boolean {
   return featuresInitialized;
 }
 
-/** @internal */
 export function errorIfFeaturesNotInitialized(featureName: string): void {
   if (!areFeaturesInitialized()) {
     error(
@@ -14,7 +12,6 @@ export function errorIfFeaturesNotInitialized(featureName: string): void {
   }
 }
 
-/** @internal */
 export function setFeaturesInitialized(): void {
   featuresInitialized = true;
 }

package/src/functions/bosses.ts

@@ -3,7 +3,7 @@ import {
   LokiVariant,
   StageType,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 import {
   ALL_BOSSES_SET,
   STAGE_TO_COMBINED_BOSS_SET_MAP,

package/src/functions/cards.ts

@@ -1,11 +1,11 @@
 import { Card, ItemConfigCardType } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_CARD,
   FIRST_MODDED_CARD,
   LAST_CARD,
   MAX_VANILLA_CARD,
-} from "../constantsFirstLast";
+} from "../core/constantsFirstLast";
 import {
   CARD_DESCRIPTIONS,
   DEFAULT_CARD_DESCRIPTION,

package/src/functions/characters.ts

@@ -1,5 +1,5 @@
 import { PlayerType } from "isaac-typescript-definitions";
-import { LAST_VANILLA_CHARACTER } from "../constantsFirstLast";
+import { LAST_VANILLA_CHARACTER } from "../core/constantsFirstLast";
 import { CHARACTER_DAMAGE_MULTIPLIERS } from "../objects/characterDamageMultipliers";
 import { CHARACTER_NAMES } from "../objects/characterNames";
 import { CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET } from "../sets/charactersThatStartWithAnActiveItemSet";

package/src/functions/charge.ts

@@ -4,7 +4,7 @@ import {
   SoundEffect,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game, sfxManager } from "../cachedClasses";
+import { game, sfxManager } from "../core/cachedClasses";
 import { getCollectibleMaxCharges } from "./collectibles";
 import { getPlayers } from "./playerIndex";
 import { getRoomShapeCharges } from "./roomShape";

package/src/functions/collectibleCacheFlag.ts

@@ -1,5 +1,5 @@
 import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";

package/src/functions/collectibleSet.ts

@@ -1,10 +1,10 @@
 import { CollectibleType } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_COLLECTIBLE_TYPE,
   LAST_COLLECTIBLE_TYPE,
   LAST_VANILLA_COLLECTIBLE_TYPE,
-} from "../constantsFirstLast";
+} from "../core/constantsFirstLast";
 import { irange } from "./utils";
 
 const ALL_COLLECTIBLES_ARRAY: CollectibleType[] = [];

package/src/functions/collectibleTag.ts

@@ -1,5 +1,5 @@
 import { CollectibleType, ItemConfigTag } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { getFlagName } from "./flag";

package/src/functions/collectibles.ts

@@ -9,14 +9,14 @@ import {
   PickupVariant,
   RoomType,
 } from "isaac-typescript-definitions";
-import { game, itemConfig } from "../cachedClasses";
-import { BLIND_ITEM_PNG_PATH, DEFAULT_ITEM_POOL_TYPE } from "../constants";
+import { game, itemConfig } from "../core/cachedClasses";
+import { BLIND_ITEM_PNG_PATH, DEFAULT_ITEM_POOL_TYPE } from "../core/constants";
 import {
   FIRST_COLLECTIBLE_TYPE,
   FIRST_MODDED_COLLECTIBLE_TYPE,
   LAST_COLLECTIBLE_TYPE,
   LAST_VANILLA_COLLECTIBLE_TYPE,
-} from "../constantsFirstLast";
+} from "../core/constantsFirstLast";
 import {
   COLLECTIBLE_DESCRIPTION_MAP,
   DEFAULT_COLLECTIBLE_DESCRIPTION,

package/src/functions/curses.ts

@@ -1,5 +1,5 @@
 import { LevelCurse } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { hasFlag } from "./flag";
 
 export function hasCurse(curse: LevelCurse): boolean {

package/src/functions/deepCopyTests.ts

@@ -6,6 +6,7 @@ import { deepCopy } from "./deepCopy";
 import { log } from "./log";
 import { isDefaultMap, isTSTLMap, isTSTLSet } from "./tstlClass";
 import { isNumber, isString, isTable } from "./types";
+import { printConsole } from "./utils";
 
 /**
  * Run the suite of tests that prove that the "deepCopy" helper function works properly.
@@ -38,7 +39,9 @@ export function runDeepCopyTests(): void {
   copiedSerializedDefaultMapHasStringKey();
   copiedSerializedDefaultMapHasNumberKey();
 
-  log("All deep copy tests passed!");
+  const successText = "All deep copy tests passed!";
+  log(successText);
+  printConsole(successText);
 }
 
 function copiedObjectIsTable() {

package/src/functions/dimensions.ts

@@ -1,6 +1,6 @@
 import { Dimension } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { NUM_DIMENSIONS } from "../constants";
+import { game } from "../core/cachedClasses";
+import { NUM_DIMENSIONS } from "../core/constants";
 import { getRoomGridIndex } from "./roomData";
 import { erange } from "./utils";
 

package/src/functions/doors.ts

@@ -8,7 +8,7 @@ import {
   RoomShape,
   RoomType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import {
   DEFAULT_DOOR_SLOT,
   DOOR_SLOT_FLAG_TO_DOOR_SLOT,

package/src/functions/entities.ts

@@ -1,6 +1,6 @@
 import { EntityType } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { VectorZero } from "../constants";
+import { game } from "../core/cachedClasses";
+import { VectorZero } from "../core/constants";
 import { STORY_BOSSES_SET } from "../sets/storyBossesSet";
 import { AnyEntity } from "../types/AnyEntity";
 import { getIsaacAPIClassName } from "./isaacAPIClass";

package/src/functions/entitiesSpecific.ts

@@ -10,7 +10,7 @@ import {
   SlotVariant,
   TearVariant,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 import { getEntities, removeEntities, spawn } from "./entities";
 
 /**

package/src/functions/familiars.ts

@@ -1,5 +1,5 @@
 import { CollectibleType, FamiliarVariant } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import { FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET } from "../sets/familiarsThatShootPlayerTearsSet";
 import { getFamiliars } from "./entitiesSpecific";
 

package/src/functions/gridEntities.ts

@@ -7,8 +7,8 @@ import {
   StatueVariant,
   TrapdoorVariant,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { DISTANCE_OF_GRID_TILE } from "../constants";
+import { game } from "../core/cachedClasses";
+import { DISTANCE_OF_GRID_TILE } from "../core/constants";
 import { GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP } from "../maps/gridEntityTypeToBrokenStateMap";
 import { GRID_ENTITY_XML_MAP } from "../maps/gridEntityXMLMap";
 import {