isaacscript-common 33.12.0 → 33.12.1

package/dist/index.rollup.d.ts

@@ -3558,12 +3558,29 @@ export declare function deserializeVector(vector: SerializedVector): Vector;
 /** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76). */
 export declare const DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75;
 
+/**
+ * Helper function to convert a direction to degrees. For example, `Direction.LEFT` (0) would return
+ * 180 and `Direction.RIGHT` (2) would return 0. (This corresponds to how the
+ * `Vector.GetAngleDegrees` method works.)
+ */
 export declare function directionToDegrees(direction: Direction): int;
 
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.LEFT` (0).
+ */
 export declare function directionToMoveAction(direction: Direction): ButtonAction | undefined;
 
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.SHOOT_LEFT` (4).
+ */
 export declare function directionToShootAction(direction: Direction): ButtonAction | undefined;
 
+/**
+ * Helper function to convert a direction to a `Vector`. For example, `Direction.LEFT` (0) would
+ * convert to `Vector(-1, 0).
+ */
 export declare function directionToVector(direction: Direction): Readonly<Vector>;
 
 declare class DisableAllSound extends Feature {
@@ -5105,6 +5122,10 @@ export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefine
  */
 export declare function getDimension(): Dimension;
 
+/**
+ * Helper function to get the lowercase name of a direction. For example, `Direction.LEFT` (0) would
+ * return "left".
+ */
 export declare function getDirectionName(direction: Direction): string | undefined;
 
 /**

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 33.12.0
+isaacscript-common 33.12.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -37332,7 +37332,7 @@ function ____exports.loadFromDisk(self, mod, oldSaveData, classConstructors)
         end,
         SAVE_DATA_MANAGER_DEBUG
     )
-    log("The save data manager loaded data from the \"save#.dat\" file.")
+    log("The save data manager loaded data from the \"save#.dat\" file for mod: " .. mod.Name)
 end
 return ____exports
  end,
@@ -37452,7 +37452,7 @@ function ____exports.saveToDisk(self, mod, saveDataMap, saveDataConditionalFuncM
     local allSaveData = getAllSaveDataToWriteToDisk(nil, saveDataMap, saveDataConditionalFuncMap)
     local jsonString = jsonEncode(nil, allSaveData)
     mod:SaveData(jsonString)
-    log("The save data manager wrote data to the \"save#.dat\" file.")
+    log("The save data manager wrote data to the \"save#.dat\" file for mod: " .. mod.Name)
 end
 return ____exports
  end,

package/dist/src/classes/features/other/saveDataManager/loadFromDisk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadFromDisk.d.ts","sourceRoot":"","sources":["../../../../../../src/classes/features/other/saveDataManager/loadFromDisk.ts"],"names":[],"mappings":";;AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAK3D,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACrC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAC1C,IAAI,CAsDN"}
+{"version":3,"file":"loadFromDisk.d.ts","sourceRoot":"","sources":["../../../../../../src/classes/features/other/saveDataManager/loadFromDisk.ts"],"names":[],"mappings":";;AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAK3D,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACrC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAC1C,IAAI,CAwDN"}

package/dist/src/classes/features/other/saveDataManager/loadFromDisk.lua

@@ -73,6 +73,6 @@ function ____exports.loadFromDisk(self, mod, oldSaveData, classConstructors)
         end,
         SAVE_DATA_MANAGER_DEBUG
     )
-    log("The save data manager loaded data from the \"save#.dat\" file.")
+    log("The save data manager loaded data from the \"save#.dat\" file for mod: " .. mod.Name)
 end
 return ____exports

package/dist/src/classes/features/other/saveDataManager/saveToDisk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveToDisk.d.ts","sourceRoot":"","sources":["../../../../../../src/classes/features/other/saveDataManager/saveToDisk.ts"],"names":[],"mappings":";;AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAGhE,wBAAgB,UAAU,CACxB,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACrC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,GACxD,IAAI,CAQN"}
+{"version":3,"file":"saveToDisk.d.ts","sourceRoot":"","sources":["../../../../../../src/classes/features/other/saveDataManager/saveToDisk.ts"],"names":[],"mappings":";;AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAGhE,wBAAgB,UAAU,CACxB,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACrC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,GACxD,IAAI,CAUN"}

package/dist/src/classes/features/other/saveDataManager/saveToDisk.lua

@@ -41,6 +41,6 @@ function ____exports.saveToDisk(self, mod, saveDataMap, saveDataConditionalFuncM
     local allSaveData = getAllSaveDataToWriteToDisk(nil, saveDataMap, saveDataConditionalFuncMap)
     local jsonString = jsonEncode(nil, allSaveData)
     mod:SaveData(jsonString)
-    log("The save data manager wrote data to the \"save#.dat\" file.")
+    log("The save data manager wrote data to the \"save#.dat\" file for mod: " .. mod.Name)
 end
 return ____exports

package/dist/src/functions/direction.d.ts

@@ -8,9 +8,30 @@ import { Direction } from "isaac-typescript-definitions";
  * works.)
  */
 export declare function angleToDirection(angleDegrees: int): Direction;
+/**
+ * Helper function to convert a direction to degrees. For example, `Direction.LEFT` (0) would return
+ * 180 and `Direction.RIGHT` (2) would return 0. (This corresponds to how the
+ * `Vector.GetAngleDegrees` method works.)
+ */
 export declare function directionToDegrees(direction: Direction): int;
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.LEFT` (0).
+ */
 export declare function directionToMoveAction(direction: Direction): ButtonAction | undefined;
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.SHOOT_LEFT` (4).
+ */
 export declare function directionToShootAction(direction: Direction): ButtonAction | undefined;
+/**
+ * Helper function to convert a direction to a `Vector`. For example, `Direction.LEFT` (0) would
+ * convert to `Vector(-1, 0).
+ */
 export declare function directionToVector(direction: Direction): Readonly<Vector>;
+/**
+ * Helper function to get the lowercase name of a direction. For example, `Direction.LEFT` (0) would
+ * return "left".
+ */
 export declare function getDirectionName(direction: Direction): string | undefined;
 //# sourceMappingURL=direction.d.ts.map

package/dist/src/functions/direction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"direction.d.ts","sourceRoot":"","sources":["../../../src/functions/direction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAOzD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,GAAG,GAAG,SAAS,CAwB7D;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE5D;AAED,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,SAAS,GACnB,YAAY,GAAG,SAAS,CAE1B;AAED,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,GACnB,YAAY,GAAG,SAAS,CAE1B;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAExE;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAEzE"}
+{"version":3,"file":"direction.d.ts","sourceRoot":"","sources":["../../../src/functions/direction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAOzD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,GAAG,GAAG,SAAS,CAwB7D;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE5D;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,SAAS,GACnB,YAAY,GAAG,SAAS,CAE1B;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,GACnB,YAAY,GAAG,SAAS,CAE1B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAExE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAEzE"}

package/dist/src/functions/direction.lua

@@ -36,18 +36,29 @@ function ____exports.angleToDirection(self, angleDegrees)
     end
     return Direction.RIGHT
 end
+--- Helper function to convert a direction to degrees. For example, `Direction.LEFT` (0) would return
+-- 180 and `Direction.RIGHT` (2) would return 0. (This corresponds to how the
+-- `Vector.GetAngleDegrees` method works.)
 function ____exports.directionToDegrees(self, direction)
     return DIRECTION_TO_DEGREES[direction]
 end
+--- Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+-- (0) would return `ButtonAction.LEFT` (0).
 function ____exports.directionToMoveAction(self, direction)
     return DIRECTION_TO_MOVE_ACTION[direction]
 end
+--- Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+-- (0) would return `ButtonAction.SHOOT_LEFT` (4).
 function ____exports.directionToShootAction(self, direction)
     return DIRECTION_TO_SHOOT_ACTION[direction]
 end
+--- Helper function to convert a direction to a `Vector`. For example, `Direction.LEFT` (0) would
+-- convert to `Vector(-1, 0).
 function ____exports.directionToVector(self, direction)
     return DIRECTION_TO_VECTOR[direction]
 end
+--- Helper function to get the lowercase name of a direction. For example, `Direction.LEFT` (0) would
+-- return "left".
 function ____exports.getDirectionName(self, direction)
     return DIRECTION_NAMES[direction]
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "33.12.0",
+  "version": "33.12.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/features/other/SaveDataManager.ts

@@ -463,7 +463,7 @@ export class SaveDataManager extends Feature {
     for (const tstlClass of tstlClasses) {
       const { name } = tstlClass;
       assertDefined(
-        // Since we are accepting untrusted user input, this might nto be a real TSTL class.
+        // Since we are accepting untrusted user input, this might not be a real TSTL class.
         name as string | undefined,
         "Failed to register a class with the save data manager due to not being able to derive the name of the class.",
       );

package/src/classes/features/other/saveDataManager/loadFromDisk.ts

@@ -67,7 +67,9 @@ export function loadFromDisk(
     SAVE_DATA_MANAGER_DEBUG,
   );
 
-  log('The save data manager loaded data from the "save#.dat" file.');
+  log(
+    `The save data manager loaded data from the "save#.dat" file for mod: ${mod.Name}`,
+  );
 }
 
 function readSaveDatFile(mod: Mod) {

package/src/classes/features/other/saveDataManager/saveToDisk.ts

@@ -17,7 +17,9 @@ export function saveToDisk(
   );
   const jsonString = jsonEncode(allSaveData);
   mod.SaveData(jsonString);
-  log('The save data manager wrote data to the "save#.dat" file.');
+  log(
+    `The save data manager wrote data to the "save#.dat" file for mod: ${mod.Name}`,
+  );
 }
 
 function getAllSaveDataToWriteToDisk(

package/src/functions/direction.ts

@@ -39,26 +39,47 @@ export function angleToDirection(angleDegrees: int): Direction {
   return Direction.RIGHT;
 }
 
+/**
+ * Helper function to convert a direction to degrees. For example, `Direction.LEFT` (0) would return
+ * 180 and `Direction.RIGHT` (2) would return 0. (This corresponds to how the
+ * `Vector.GetAngleDegrees` method works.)
+ */
 export function directionToDegrees(direction: Direction): int {
   return DIRECTION_TO_DEGREES[direction];
 }
 
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.LEFT` (0).
+ */
 export function directionToMoveAction(
   direction: Direction,
 ): ButtonAction | undefined {
   return DIRECTION_TO_MOVE_ACTION[direction];
 }
 
+/**
+ * Helper function to convert a direction to a shoot `ButtonAction`. For example, `Direction.LEFT`
+ * (0) would return `ButtonAction.SHOOT_LEFT` (4).
+ */
 export function directionToShootAction(
   direction: Direction,
 ): ButtonAction | undefined {
   return DIRECTION_TO_SHOOT_ACTION[direction];
 }
 
+/**
+ * Helper function to convert a direction to a `Vector`. For example, `Direction.LEFT` (0) would
+ * convert to `Vector(-1, 0).
+ */
 export function directionToVector(direction: Direction): Readonly<Vector> {
   return DIRECTION_TO_VECTOR[direction];
 }
 
+/**
+ * Helper function to get the lowercase name of a direction. For example, `Direction.LEFT` (0) would
+ * return "left".
+ */
 export function getDirectionName(direction: Direction): string | undefined {
   return DIRECTION_NAMES[direction];
 }