isaacscript-common 6.11.2 → 6.14.0

package/src/functions/vector.ts

@@ -3,6 +3,8 @@ import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
 import { angleToDirection } from "./direction";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
+import { getRandomFloat } from "./random";
+import { getRandomSeed, isRNG, newRNG } from "./rng";
 import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";
 
@@ -90,6 +92,27 @@ export function copyVector(
   }
 }
 
+/**
+ * Helper function to get a random vector between (-1, -1) and (1, 1).
+ *
+ * To get random vectors with a bigger length, multiply this with a number.
+ *
+ * Use this over the `RandomVector` function when you need the vector to be seeded.
+ *
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ */
+export function getRandomVector(
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+): Vector {
+  const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
+
+  const x = getRandomFloat(-1, 1, rng);
+  const y = getRandomFloat(-1, 1, rng);
+
+  return Vector(x, y);
+}
+
 /**
  * Used to determine is the given table is a serialized `Vector` object created by the save data
  * manager and/or the `deepCopy` function.

package/src/index.ts

@@ -47,10 +47,12 @@ export * from "./features/extraConsoleCommands/exports";
 export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
+export { pause, unpause } from "./features/pause";
 export {
   removePersistentEntity,
   spawnPersistentEntity,
 } from "./features/persistentEntities";
+export * from "./features/pickupIndex";
 export { getPlayerInventory } from "./features/playerInventory";
 export {
   anyPlayerUsingPony,
@@ -62,6 +64,7 @@ export {
   getRoomClearGameFrame,
   getRoomClearRoomFrame,
 } from "./features/roomClearFrame";
+export * from "./features/roomHistory";
 export {
   runInNGameFrames,
   runInNRenderFrames,
@@ -141,6 +144,7 @@ export * from "./functions/pressurePlate";
 export * from "./functions/random";
 export * from "./functions/revive";
 export * from "./functions/rng";
+export * from "./functions/rockAlt";
 export * from "./functions/roomData";
 export * from "./functions/roomGrid";
 export * from "./functions/rooms";

package/src/initCustomCallbacks.ts

@@ -20,6 +20,8 @@ import { postFlipCallbacksInit } from "./callbacks/postFlip";
 import { postGreedModeWaveInit } from "./callbacks/postGreedModeWave";
 import { postGridEntityCallbacksInit } from "./callbacks/postGridEntity";
 import { postGridEntityCollisionInit } from "./callbacks/postGridEntityCollision";
+import { postGridEntityCustomRenderInit } from "./callbacks/postGridEntityCustomRender";
+import { postGridEntityCustomUpdateInit } from "./callbacks/postGridEntityCustomUpdate";
 import { postGridEntityRenderInit } from "./callbacks/postGridEntityRender";
 import { postHolyMantleRemovedInit } from "./callbacks/postHolyMantleRemoved";
 import { postItemDischargeInit } from "./callbacks/postItemDischarged";
@@ -89,6 +91,8 @@ export function initCustomCallbacks(mod: ModUpgraded): void {
   postGreedModeWaveInit(mod);
   postGridEntityCallbacksInit(mod);
   postGridEntityCollisionInit(mod);
+  postGridEntityCustomRenderInit(mod);
+  postGridEntityCustomUpdateInit(mod);
   postGridEntityRenderInit(mod);
   postHolyMantleRemovedInit(mod);
   postItemDischargeInit(mod);

package/src/initFeatures.ts

@@ -13,11 +13,13 @@ import { fastResetInit } from "./features/fastReset";
 import { forgottenSwitchInit } from "./features/forgottenSwitch";
 import { pauseInit } from "./features/pause";
 import { persistentEntitiesInit } from "./features/persistentEntities";
+import { pickupIndexInit } from "./features/pickupIndex";
 import { playerInventoryInit } from "./features/playerInventory";
 import { ponyDetectionInit } from "./features/ponyDetection";
 import { preventCollectibleRotationInit } from "./features/preventCollectibleRotation";
 import { registerHotkeyInit } from "./features/registerHotkey";
 import { roomClearFrameInit } from "./features/roomClearFrame";
+import { roomHistoryInit } from "./features/roomHistory";
 import { runInNFramesInit } from "./features/runInNFrames";
 import { runNextRoomInit } from "./features/runNextRoom";
 import { sirenHelpersInit } from "./features/sirenHelpers";
@@ -48,11 +50,13 @@ function initFeaturesMinor(mod: ModUpgraded) {
   collectibleItemPoolTypeInit(mod);
   pauseInit(mod);
   persistentEntitiesInit(mod);
+  pickupIndexInit(mod);
   playerInventoryInit(mod);
   ponyDetectionInit(mod);
   preventCollectibleRotationInit(mod);
   registerHotkeyInit(mod);
   roomClearFrameInit(mod);
+  roomHistoryInit(mod);
   runNextRoomInit(mod);
   sirenHelpersInit(mod);
   stageHistoryInit(mod);

package/src/interfaces/AddCallbackParameterCustom.ts

@@ -23,6 +23,8 @@ import { PostGameStartedReorderedRegisterParameters } from "../callbacks/subscri
 import { PostGreedModeWaveRegisterParameters } from "../callbacks/subscriptions/postGreedModeWave";
 import { PostGridEntityBrokenRegisterParameters } from "../callbacks/subscriptions/postGridEntityBroken";
 import { PostGridEntityCollisionRegisterParameters } from "../callbacks/subscriptions/postGridEntityCollision";
+import { PostGridEntityCustomRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomRender";
+import { PostGridEntityCustomUpdateRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomUpdate";
 import { PostGridEntityInitRegisterParameters } from "../callbacks/subscriptions/postGridEntityInit";
 import { PostGridEntityRemoveRegisterParameters } from "../callbacks/subscriptions/postGridEntityRemove";
 import { PostGridEntityRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityRender";
@@ -109,6 +111,8 @@ export interface AddCallbackParameterCustom {
   [ModCallbackCustom.POST_GREED_MODE_WAVE]: PostGreedModeWaveRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: PostGridEntityBrokenRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollisionRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_RENDER]: PostGridEntityCustomRenderRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE]: PostGridEntityCustomUpdateRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_INIT]: PostGridEntityInitRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: PostGridEntityRemoveRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_RENDER]: PostGridEntityRenderRegisterParameters;

package/src/interfaces/RoomDescription.ts

@@ -0,0 +1,19 @@
+import {
+  LevelStage,
+  RoomType,
+  StageID,
+  StageType,
+} from "isaac-typescript-definitions";
+
+/** Used by the room history feature. */
+export interface RoomDescription {
+  stage: LevelStage;
+  stageType: StageType;
+  stageID: StageID;
+  roomType: RoomType;
+  roomVariant: int;
+  roomSubType: int;
+  roomName: string;
+  roomGridIndex: int;
+  roomListIndex: int;
+}

package/src/objects/callbackRegisterFunctions.ts

@@ -23,6 +23,8 @@ import { postGameStartedReorderedRegister } from "../callbacks/subscriptions/pos
 import { postGreedModeWaveRegister } from "../callbacks/subscriptions/postGreedModeWave";
 import { postGridEntityBrokenRegister } from "../callbacks/subscriptions/postGridEntityBroken";
 import { postGridEntityCollisionRegister } from "../callbacks/subscriptions/postGridEntityCollision";
+import { postGridEntityCustomRenderRegister } from "../callbacks/subscriptions/postGridEntityCustomRender";
+import { postGridEntityCustomUpdateRegister } from "../callbacks/subscriptions/postGridEntityCustomUpdate";
 import { postGridEntityInitRegister } from "../callbacks/subscriptions/postGridEntityInit";
 import { postGridEntityRemoveRegister } from "../callbacks/subscriptions/postGridEntityRemove";
 import { postGridEntityRenderRegister } from "../callbacks/subscriptions/postGridEntityRender";
@@ -118,6 +120,10 @@ export const CALLBACK_REGISTER_FUNCTIONS: {
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: postGridEntityBrokenRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]:
     postGridEntityCollisionRegister,
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_RENDER]:
+    postGridEntityCustomRenderRegister,
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE]:
+    postGridEntityCustomUpdateRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_INIT]: postGridEntityInitRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: postGridEntityRemoveRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_RENDER]: postGridEntityRenderRegister,

package/src/types/CollectibleIndex.ts

@@ -1,5 +1,5 @@
 /**
- * CollectibleIndex is a specific type of string; see the documentation for the
+ * `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.
  *

package/src/types/PickupIndex.ts

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

package/src/types/PlayerIndex.ts

@@ -1,5 +1,5 @@
 /**
- * PlayerIndex is a specific type of number that represents a unique identifier for a player. Mods
+ * `PlayerIndex` is a specific type of number that represents a unique identifier for a player. Mods
  * can signify that data structures handle `EntityPlayer` by using this type. For more information,
  * see the documentation for the `getPlayerIndex` function.
  *

package/src/upgradeMod.ts

@@ -39,7 +39,8 @@ export function upgradeMod(modVanilla: Mod): ModUpgraded {
     patchErrorFunction();
     loadShaderCrashFix(modVanilla);
 
-    // We initialize the PostNewRoomEarly callback first since it is used by the save data manager.
+    // We initialize the `POST_NEW_ROOM_EARLY` 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