isaacscript-common 9.12.1 → 9.13.2

package/dist/types/PossibleStatType.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { TearFlag } from "isaac-typescript-definitions";
 /**
  * These are the possible types that player stats can be. For example, `EntityPlayer.Damage` is of

package/dist/types/PossibleStatType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PossibleStatType.d.ts","sourceRoot":"","sources":["../../src/types/PossibleStatType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD;;;GAGG;AACH,oBAAY,gBAAgB,GACxB,MAAM,GACN,OAAO,GACP,QAAQ,CAAC,QAAQ,CAAC,GAClB,KAAK,GACL,MAAM,CAAC"}
+{"version":3,"file":"PossibleStatType.d.ts","sourceRoot":"","sources":["../../src/types/PossibleStatType.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD;;;GAGG;AACH,oBAAY,gBAAgB,GACxB,MAAM,GACN,OAAO,GACP,QAAQ,CAAC,QAAQ,CAAC,GAClB,KAAK,GACL,MAAM,CAAC"}

package/dist/types/SerializedIsaacAPIClass.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="typescript-to-lua/language-extensions" />
+/** @noSelfInFile */
 /**
  * This is a type representing an Isaac API class like `Color` or `RNG` that has been written to the
  * "save#.dat" file. It is used by the save data manager when reading and writing to that file.

package/dist/types/SerializedIsaacAPIClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerializedIsaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/types/SerializedIsaacAPIClass.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,oBAAY,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC9D,QAAQ,CAAC,8BAA8B,EAAE,MAAM,CAAC;CACjD,CAAC"}
+{"version":3,"file":"SerializedIsaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/types/SerializedIsaacAPIClass.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,oBAAY,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC9D,QAAQ,CAAC,8BAA8B,EAAE,MAAM,CAAC;CACjD,CAAC"}

package/dist/types/TSTLClass.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="typescript-to-lua/language-extensions" />
+/** @noSelfInFile */
 /**
  * This is a type representing a user-created class from TypeScript code.
  *

package/dist/types/TSTLClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;GAIG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}
+{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../src/types/TSTLClass.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.12.1",
+  "version": "9.13.2",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^4.0.4"
+    "isaac-typescript-definitions": "^4.0.5"
   }
 }

package/src/callbacks/postEsauJr.ts

@@ -10,7 +10,7 @@ import {
 } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { saveDataManager } from "../features/saveDataManager/exports";
-import { getPlayers } from "../functions/playerIndex";
+import { getPlayersWithControllerIndex } from "../functions/players";
 import {
   postEsauJrFire,
   postEsauJrHasSubscriptions,
@@ -65,8 +65,12 @@ function postUpdate() {
   if (v.run.usedEsauJrControllerIndex === null) {
     return;
   }
-  const player = getPlayerWithControllerIndex(v.run.usedEsauJrControllerIndex);
+  const players = getPlayersWithControllerIndex(
+    v.run.usedEsauJrControllerIndex,
+  );
   v.run.usedEsauJrControllerIndex = null;
+
+  const player = players[0];
   if (player === undefined) {
     return;
   }
@@ -79,11 +83,6 @@ function postUpdate() {
   postEsauJrFire(player);
 }
 
-function getPlayerWithControllerIndex(controllerIndex: ControllerIndex) {
-  const players = getPlayers();
-  return players.find((player) => player.ControllerIndex === controllerIndex);
-}
-
 // ModCallback.POST_USE_ITEM (3)
 // CollectibleType.ESAU_JR (703)
 function useItemEsauJr(

package/src/features/customPickup.ts

@@ -13,9 +13,10 @@ import { spawnEffect } from "../functions/entitiesSpecific";
 
 const FEATURE_NAME = "customPickup";
 
+/** We must specify "this: void" to prevent compiler errors. */
 interface CustomPickupFunctions {
-  collectFunc: (player: EntityPlayer) => void;
-  collisionFunc: (player: EntityPlayer) => boolean;
+  collectFunc: (this: void, player: EntityPlayer) => void;
+  collisionFunc: (this: void, player: EntityPlayer) => boolean;
 }
 
 /**

package/src/features/customStage/exports.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
 /**
  * These are helper functions relating to creating custom stages with the built-in standard library.
  * For more information about custom stages, see the [main

package/src/functions/log.ts

@@ -64,20 +64,17 @@ export function getDebugPrependString(
  * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
  * function will also prepend the function name and the line number before the string.
  */
-export function log(this: void, msg: string): void {
+export function log(msg: string): void {
   const debugMsg = getDebugPrependString(msg);
   Isaac.DebugString(debugMsg);
 }
 
-export function logArray<T>(this: void, array: T[] | readonly T[]): void {
+export function logArray<T>(array: T[] | readonly T[]): void {
   const arrayString = arrayToString(array);
   log(`Array: ${arrayString}`);
 }
 
-export function logCollectibleTypes(
-  this: void,
-  collectibleTypes: CollectibleType[],
-): void {
+export function logCollectibleTypes(collectibleTypes: CollectibleType[]): void {
   log("Collectibles:");
 
   let i = 1;
@@ -88,29 +85,23 @@ export function logCollectibleTypes(
   }
 }
 
-export function logColor(this: void, color: Color): void {
+export function logColor(color: Color): void {
   log(
     `Color: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
   );
 }
 
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
-export function logDamageFlags(
-  this: void,
-  flags: DamageFlag | BitFlags<DamageFlag>,
-): void {
+export function logDamageFlags(flags: DamageFlag | BitFlags<DamageFlag>): void {
   logFlags(flags, DamageFlag, "damage");
 }
 
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
-export function logEntityFlags(
-  this: void,
-  flags: EntityFlag | BitFlags<EntityFlag>,
-): void {
+export function logEntityFlags(flags: EntityFlag | BitFlags<EntityFlag>): void {
   logFlags(flags, EntityFlag, "entity");
 }
 
-export function logEntityID(this: void, entity: Entity): void {
+export function logEntityID(entity: Entity): void {
   const entityID = getEntityID(entity);
   log(`Entity: ${entityID}`);
 }
@@ -121,7 +112,7 @@ export function logEntityID(this: void, entity: Entity): void {
  * This is useful in situations where using the `error` function would be dangerous (since it
  * prevents all of the subsequent code in the callback from running).
  */
-export function logError(this: void, msg: string): void {
+export function logError(msg: string): void {
   const errorMsg = `Error: ${msg}`;
   log(errorMsg);
   printConsole(errorMsg);
@@ -129,7 +120,6 @@ export function logError(this: void, msg: string): void {
 
 /** Helper function for printing out every flag that is turned on. Useful when debugging. */
 export function logFlags<T extends BitFlag | BitFlag128>(
-  this: void,
   flags: T | BitFlags<T>,
   flagEnum: Record<string, T>,
   description = "",
@@ -157,7 +147,7 @@ export function logFlags<T extends BitFlag | BitFlag128>(
 /**
  * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */
-export function logGameStateFlags(this: void): void {
+export function logGameStateFlags(): void {
   log("Logging game state flags:");
 
   const gameStateFlagEntries = getEnumEntries(GameStateFlag);
@@ -176,7 +166,7 @@ export function logGameStateFlags(this: void): void {
   }
 }
 
-export function logKColor(this: void, kColor: KColor): void {
+export function logKColor(kColor: KColor): void {
   log(
     `Color: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
   );
@@ -185,7 +175,7 @@ export function logKColor(this: void, kColor: KColor): void {
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
-export function logLevelStateFlags(this: void): void {
+export function logLevelStateFlags(): void {
   const level = game.GetLevel();
 
   const levelStateFlagEntries = getEnumEntries(LevelStateFlag);
@@ -205,7 +195,7 @@ export function logLevelStateFlags(this: void): void {
   }
 }
 
-export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
+export function logMap(map: Map<AnyNotNil, unknown>): void {
   log("Printing out a TSTL Map:");
 
   const mapKeys = [...map.keys()];
@@ -220,7 +210,7 @@ export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
   log(`  The size of the map was: ${map.size}`);
 }
 
-export function logPlayerEffects(this: void, player: EntityPlayer): void {
+export function logPlayerEffects(player: EntityPlayer): void {
   const effects = getEffectsList(player);
 
   log("Logging player effects:");
@@ -248,7 +238,7 @@ export function logPlayerEffects(this: void, player: EntityPlayer): void {
   });
 }
 
-export function logPlayerHealth(this: void, player: EntityPlayer): void {
+export function logPlayerHealth(player: EntityPlayer): void {
   const playerName = getPlayerName(player);
   const playerHealth = getPlayerHealth(player);
 
@@ -274,14 +264,13 @@ export function logPlayerHealth(this: void, player: EntityPlayer): void {
  * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
  */
 export function logProjectileFlags(
-  this: void,
   flags: ProjectileFlag | BitFlags<ProjectileFlag>,
 ): void {
   logFlags(flags, ProjectileFlag, "projectile");
 }
 
 /** Helper function for logging information about the current room. */
-export function logRoom(this: void): void {
+export function logRoom(): void {
   const room = game.GetRoom();
   const bossID = room.GetBossID();
   const roomGridIndex = getRoomGridIndex();
@@ -315,7 +304,7 @@ export function logRoom(this: void): void {
  * Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
-export function logSeedEffects(this: void): void {
+export function logSeedEffects(): void {
   const seeds = game.GetSeeds();
 
   const seedEffectEntries = getEnumEntries(SeedEffect);
@@ -334,10 +323,7 @@ export function logSeedEffects(this: void): void {
   }
 }
 
-export function logSet(
-  this: void,
-  set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>,
-): void {
+export function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void {
   log("Printing out a TSTL Set:");
 
   const setValues = getSortedSetValues(set);
@@ -350,7 +336,7 @@ export function logSet(
 }
 
 /** Helper function for logging every sound effect that is currently playing. */
-export function logSounds(this: void): void {
+export function logSounds(): void {
   const soundEffects = getEnumEntries(SoundEffect);
 
   for (const [key, soundEffect] of soundEffects) {
@@ -367,11 +353,7 @@ export function logSounds(this: void): void {
  * This function will only work on tables that have string keys (because it logs the keys in order,
  * instead of randomly). It will throw a run-time error if it encounters a non-string key.
  */
-export function logTable(
-  this: void,
-  luaTable: unknown,
-  parentTables = 0,
-): void {
+export function logTable(luaTable: unknown, parentTables = 0): void {
   if (parentTables === 0) {
     log("Printing out a Lua table:");
   }
@@ -421,7 +403,6 @@ export function logTable(
  * will only do a shallow comparison.
  */
 export function logTableDifferences<K, V>(
-  this: void,
   table1: LuaMap<K, V>,
   table2: LuaMap<K, V>,
 ): void {
@@ -453,18 +434,12 @@ export function logTableDifferences<K, V>(
 }
 
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
-export function logTearFlags(
-  this: void,
-  flags: TearFlag | BitFlags<TearFlag>,
-): void {
+export function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void {
   logFlags(flags, TearFlag, "tear");
 }
 
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
-export function logUseFlags(
-  this: void,
-  flags: UseFlag | BitFlags<UseFlag>,
-): void {
+export function logUseFlags(flags: UseFlag | BitFlags<UseFlag>): void {
   logFlags(flags, UseFlag, "use");
 }
 
@@ -472,7 +447,7 @@ export function logUseFlags(
  * Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
  * the Isaac API).
  */
-export function logUserdata(this: void, userdata: unknown): void {
+export function logUserdata(userdata: unknown): void {
   if (!isUserdata(userdata)) {
     log("Userdata: [not userdata]");
     return;
@@ -496,7 +471,7 @@ export function logUserdata(this: void, userdata: unknown): void {
   logTable(metatable);
 }
 
-export function logVector(this: void, vector: Vector, round = false): void {
+export function logVector(vector: Vector, round = false): void {
   const vectorString = vectorToString(vector, round);
   log(`Vector: ${vectorString}`);
 }

package/src/functions/logEntities.ts

@@ -21,7 +21,6 @@ const IGNORE_EFFECT_VARIANTS: ReadonlySet<EffectVariant> = new Set([
 
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export function logAllEntities(
-  this: void,
   includeBackgroundEffects: boolean,
   entityTypeFilter?: EntityType,
 ): void {
@@ -69,7 +68,6 @@ export function logAllEntities(
  * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
  */
 export function logAllGridEntities(
-  this: void,
   includeWalls: boolean,
   gridEntityTypeFilter?: GridEntityType,
 ): void {
@@ -120,14 +118,14 @@ export function logAllGridEntities(
 }
 
 /** Helper function for logging an array of specific entities. */
-export function logEntities(this: void, entities: Entity[]): void {
+export function logEntities(entities: Entity[]): void {
   for (const entity of entities) {
     logEntity(entity);
   }
 }
 
 /** Helper function to log information about a specific entity. */
-export function logEntity(this: void, entity: Entity): void {
+export function logEntity(entity: Entity): void {
   const msg = getEntityLogLine(entity);
   log(msg);
 }
@@ -206,14 +204,14 @@ function getEntityLogLine(entity: Entity, num?: int): string {
 }
 
 /** Helper function for logging an array of specific grid entities. */
-export function logGridEntities(this: void, gridEntities: GridEntity[]): void {
+export function logGridEntities(gridEntities: GridEntity[]): void {
   for (const gridEntity of gridEntities) {
     logGridEntity(gridEntity);
   }
 }
 
 /** Helper function for log information about a specific grid entity. */
-export function logGridEntity(this: void, gridEntity: GridEntity): void {
+export function logGridEntity(gridEntity: GridEntity): void {
   const msg = getGridEntityLogLine(gridEntity);
   log(msg);
 }
@@ -279,7 +277,7 @@ function getGridEntityLogLine(gridEntity: GridEntity, num?: int): string {
  * Helper function to log information about the entity that corresponding to a pointer hash. (Only
  * use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export function logPtrHash(this: void, ptrHash: PtrHash): void {
+export function logPtrHash(ptrHash: PtrHash): void {
   log(`PtrHash: ${ptrHash}`);
   const entity = getEntityFromPtrHash(ptrHash);
   if (entity === undefined) {
@@ -293,7 +291,7 @@ export function logPtrHash(this: void, ptrHash: PtrHash): void {
  * Helper function to log information about the entity that corresponding to one or more pointer
  * hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export function logPtrHashes(this: void, ptrHashes: PtrHash[]): void {
+export function logPtrHashes(ptrHashes: PtrHash[]): void {
   for (const ptrHash of ptrHashes) {
     logPtrHash(ptrHash);
   }

package/src/functions/playerIndex.ts

@@ -47,7 +47,7 @@ export function getOtherPlayers(player: EntityPlayer): EntityPlayer[] {
 export function getPlayerFromIndex(
   playerIndex: PlayerIndex,
 ): EntityPlayer | undefined {
-  const players = getPlayers();
+  const players = getAllPlayers();
   return players.find((player) => getPlayerIndex(player) === playerIndex);
 }
 

package/src/functions/players.ts

@@ -2,6 +2,7 @@ import {
   ActiveSlot,
   Challenge,
   CollectibleType,
+  ControllerIndex,
   FamiliarVariant,
   NullItemID,
   PlayerForm,
@@ -347,6 +348,21 @@ export function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[] {
   });
 }
 
+/**
+ * Helper function to get all of the players that match the provided controller index. This function
+ * returns an array of players because it is possible that there is more than one player with the
+ * same controller index (e.g. Jacob & Esau).
+ *
+ * Note that this function includes players with a non-undefined parent like e.g. the Strawman
+ * Keeper.
+ */
+export function getPlayersOnKeyboard(): EntityPlayer[] {
+  const players = getAllPlayers();
+  return players.filter(
+    (player) => player.ControllerIndex === ControllerIndex.KEYBOARD,
+  );
+}
+
 /**
  * Helper function to get only the players that have a certain collectible.
  *
@@ -364,6 +380,21 @@ export function getPlayersWithCollectible(
   );
 }
 
+/**
+ * Helper function to get all of the players that match the provided controller index. This function
+ * returns an array of players because it is possible that there is more than one player with the
+ * same controller index (e.g. Jacob & Esau).
+ *
+ * Note that this function includes players with a non-undefined parent like e.g. the Strawman
+ * Keeper.
+ */
+export function getPlayersWithControllerIndex(
+  controllerIndex: ControllerIndex,
+): EntityPlayer[] {
+  const players = getAllPlayers();
+  return players.filter((player) => player.ControllerIndex === controllerIndex);
+}
+
 /**
  * Helper function to get only the players that have a certain trinket.
  *

package/src/functions/positionVelocity.ts

@@ -21,7 +21,12 @@ export function anyEntityCloserThan(
   );
 }
 
-/** Iterates over all players and checks if any player is close enough to the specified position. */
+/**
+ * Iterates over all players and checks if any player is close enough to the specified position.
+ *
+ * Note that this function does not consider players with a non-undefined parent, since they are not
+ * real players (e.g. the Strawman Keeper).
+ */
 export function anyPlayerCloserThan(
   position: Vector,
   distance: float,

package/src/functions/set.ts

@@ -1,5 +1,6 @@
 import { getArrayCombinations, getRandomArrayElement, sumArray } from "./array";
 import { getRandomSeed } from "./rng";
+import { isPrimitive } from "./types";
 
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
@@ -118,6 +119,18 @@ export function getSetCombinations<T>(
 export function getSortedSetValues<T>(set: Set<T> | ReadonlySet<T>): T[] {
   const values = set.values();
   const array = [...values];
+
+  // Check for problematic types in order to throw a helpful error message.
+  const firstElement = array[0];
+  if (firstElement !== undefined) {
+    const arrayType = type(firstElement);
+    if (!isPrimitive(arrayType)) {
+      error(
+        `Failed to get the sorted set values because the provided set was of type "${arrayType}". Having sets with non-primitive types doesn't make much sense in general, so you might need to rethink what you are doing.`,
+      );
+    }
+  }
+
   array.sort();
 
   return array;

package/src/lib/jsonLua.d.ts

@@ -4,7 +4,9 @@
  *
  * This parser was measured to be 11.8 times faster than the vanilla parser at decoding a sample
  * "save1.dat" file.
+ *
+ * @noSelfInFile
  */
 
-export function encode(this: void, data: unknown): string;
-export function decode(this: void, data: string): unknown;
+export function encode(data: unknown): string;
+export function decode(data: string): unknown;