isaacscript-common 26.2.1 → 26.3.0

package/dist/index.rollup.d.ts

@@ -8722,12 +8722,29 @@ export declare function logAllGridEntities(this: void, includeWalls?: boolean, g
  */
 export declare function logAndPrint(msg: string): void;
 
-/** Helper function to enumerate all of the values in an array. */
-export declare function logArray<T>(this: void, array: T[] | readonly T[]): void;
+/**
+ * Helper function to log all of the values in an array.
+ *
+ * @param array The array to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logArray<T>(this: void, array: T[] | readonly T[], name?: string): void;
 
-export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[]): void;
+/**
+ * Helper function to log the names of a collectible type array.
+ *
+ * @param collectibleTypes The collectible types to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[], name?: string): void;
 
-export declare function logColor(this: void, color: Color): void;
+/**
+ * Helper function to log a `Color` object.
+ *
+ * @param color The `Color` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logColor(this: void, color: Color, name?: string): void;
 
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
@@ -8765,14 +8782,26 @@ export declare function logGridEntities(this: void, gridEntities: GridEntity[]):
 /** Helper function for log information about a specific grid entity. */
 export declare function logGridEntity(this: void, gridEntity: GridEntity): void;
 
-export declare function logKColor(this: void, kColor: KColor): void;
+/**
+ * Helper function to log a `KColor` object.
+ *
+ * @param kColor The `KColor` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logKColor(this: void, kColor: KColor, name?: string): void;
 
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
 export declare function logLevelStateFlags(this: void): void;
 
-export declare function logMap(this: void, map: Map<AnyNotNil, unknown>): void;
+/**
+ * Helper function to log a TSTL `Map`.
+ *
+ * @param map The TSTL `Map` to log.
+ * @param name Optional. The name of the map, which will be logged before the elements.
+ */
+export declare function logMap(this: void, map: Map<AnyNotNil, unknown>, name?: string): void;
 
 export declare function logMusic(this: void): void;
 
@@ -8808,7 +8837,13 @@ export declare function logRoom(this: void): void;
  */
 export declare function logSeedEffects(this: void): void;
 
-export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
+/**
+ * Helper function to log a TSTL `Set`.
+ *
+ * @param set The TSTL `Set` to log.
+ * @param name Optional. The name of the set, which will be logged before the elements.
+ */
+export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>, name?: string): void;
 
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(this: void): void;
@@ -8851,7 +8886,15 @@ export declare function logUseFlags(this: void, flags: UseFlag | BitFlags<UseFla
  */
 export declare function logUserdata(this: void, userdata: unknown): void;
 
-export declare function logVector(this: void, vector: Vector, round?: boolean): void;
+/**
+ * Helper function to log a `Vector` object.
+ *
+ * @param vector The `Vector` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
+export declare function logVector(this: void, vector: Vector, name?: string, round?: boolean): void;
 
 /** Helper type to match all of the lowercase keys of an object. */
 export declare type LowercaseKeys<T> = StartsWithLowercase<keyof T>;
@@ -15720,6 +15763,13 @@ export declare const VectorOne: Readonly<Vector>;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
 
+/**
+ * Helper function to convert a vector to a string.
+ *
+ * @param vector The vector to convert.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
 export declare function vectorToString(vector: Vector, round?: boolean): string;
 
 /**

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 26.2.1
+isaacscript-common 26.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -28489,6 +28489,7 @@ local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____log = require("src.functions.log")
 local log = ____log.log
+local logAndPrint = ____log.logAndPrint
 local ____playerHealth = require("src.functions.playerHealth")
 local getPlayerHealth = ____playerHealth.getPlayerHealth
 local ____players = require("src.functions.players")
@@ -28535,16 +28536,22 @@ function ____exports.logFlags(flags, flagEnum, description)
         log("  n/a (no flags)")
     end
 end
-function ____exports.logArray(array)
+function ____exports.logArray(array, name)
     if not isArray(nil, array, false) then
         log("Tried to log an array, but the given object was not an array.")
         return
     end
     local arrayString = arrayToString(nil, array)
-    log("Array: " .. arrayString)
+    if name == nil then
+        name = "array"
+    end
+    log((("Logging " .. name) .. ": ") .. arrayString)
 end
-function ____exports.logCollectibleTypes(collectibleTypes)
-    log("Collectibles:")
+function ____exports.logCollectibleTypes(collectibleTypes, name)
+    if name == nil then
+        name = "collectibles"
+    end
+    log(("Logging " .. name) .. ":")
     local i = 1
     for ____, collectibleType in ipairs(collectibleTypes) do
         local collectibleName = getCollectibleName(nil, collectibleType)
@@ -28552,8 +28559,11 @@ function ____exports.logCollectibleTypes(collectibleTypes)
         i = i + 1
     end
 end
-function ____exports.logColor(color)
-    log((((((((((((("Color: R" .. tostring(color.R)) .. ", G") .. tostring(color.G)) .. ", B") .. tostring(color.B)) .. ", A") .. tostring(color.A)) .. ", RO") .. tostring(color.RO)) .. ", BO") .. tostring(color.BO)) .. ", GO") .. tostring(color.GO))
+function ____exports.logColor(color, name)
+    if name == nil then
+        name = "color"
+    end
+    log((((((((((((((("Logging " .. name) .. ": R") .. tostring(color.R)) .. ", G") .. tostring(color.G)) .. ", B") .. tostring(color.B)) .. ", A") .. tostring(color.A)) .. ", RO") .. tostring(color.RO)) .. ", BO") .. tostring(color.BO)) .. ", GO") .. tostring(color.GO))
 end
 function ____exports.logDamageFlags(flags)
     ____exports.logFlags(flags, DamageFlag, "damage")
@@ -28563,12 +28573,11 @@ function ____exports.logEntityFlags(flags)
 end
 function ____exports.logEntityID(entity)
     local entityID = getEntityID(nil, entity)
-    log("Entity: " .. entityID)
+    log("Logging entity: " .. entityID)
 end
 function ____exports.logError(msg)
     local errorMsg = "Error: " .. msg
-    log(errorMsg)
-    print(errorMsg)
+    logAndPrint(nil, errorMsg)
 end
 function ____exports.logGameStateFlags()
     log("Logging game state flags:")
@@ -28587,8 +28596,11 @@ function ____exports.logGameStateFlags()
         log("  n/a (no flags)")
     end
 end
-function ____exports.logKColor(kColor)
-    log((((((("Color: R" .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))
+function ____exports.logKColor(kColor, name)
+    if name == nil then
+        name = "KColor"
+    end
+    log((((((((("Logging " .. name) .. ": R") .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))
 end
 function ____exports.logLevelStateFlags()
     local level = game:GetLevel()
@@ -28608,12 +28620,13 @@ function ____exports.logLevelStateFlags()
         log("  n/a (no flags)")
     end
 end
-function ____exports.logMap(map)
+function ____exports.logMap(map, name)
     if not isTSTLMap(nil, map) and not isDefaultMap(nil, map) then
         log("Tried to log a TSTL map, but the given object was not a TSTL map.")
         return
     end
-    log("Printing out a TSTL map:")
+    local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
+    log(("Printing out a TSTL map" .. suffix) .. ":")
     local mapKeys = {__TS__Spread(map:keys())}
     __TS__ArraySort(mapKeys)
     for ____, key in ipairs(mapKeys) do
@@ -28681,7 +28694,7 @@ function ____exports.logRoom()
     local roomGridIndex = getRoomGridIndex(nil)
     local roomListIndex = getRoomListIndex(nil)
     local roomData = getRoomData(nil)
-    log("Current room information:")
+    log("Logging room information:")
     if roomData == nil then
         log("- Room data is undefined.")
     else
@@ -28715,12 +28728,13 @@ function ____exports.logSeedEffects()
         log("  n/a (no seed effects)")
     end
 end
-function ____exports.logSet(set)
+function ____exports.logSet(set, name)
     if not isTSTLSet(nil, set) then
         log("Tried to log a TSTL set, but the given object was not a TSTL set.")
         return
     end
-    log("Printing out a TSTL set:")
+    local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
+    log(("Printing out a TSTL set" .. suffix) .. ":")
     local setValues = getSortedSetValues(nil, set)
     for ____, value in ipairs(setValues) do
         log("  Value: " .. tostring(value))
@@ -28846,12 +28860,15 @@ function ____exports.logUserdata(userdata)
     end
     ____exports.logTable(metatable)
 end
-function ____exports.logVector(vector, round)
+function ____exports.logVector(vector, name, round)
     if round == nil then
         round = false
     end
+    if name == nil then
+        name = "vector"
+    end
     local vectorString = vectorToString(nil, vector, round)
-    log("Vector: " .. vectorString)
+    log((("Logging " .. name) .. ": ") .. vectorString)
 end
 return ____exports
  end,

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

@@ -1,9 +1,26 @@
 /// <reference types="@typescript-to-lua/language-extensions" />
 import { CollectibleType, DamageFlag, EntityFlag, ProjectileFlag, TearFlag, UseFlag } from "isaac-typescript-definitions";
-/** Helper function to enumerate all of the values in an array. */
-export declare function logArray<T>(this: void, array: T[] | readonly T[]): void;
-export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[]): void;
-export declare function logColor(this: void, color: Color): void;
+/**
+ * Helper function to log all of the values in an array.
+ *
+ * @param array The array to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logArray<T>(this: void, array: T[] | readonly T[], name?: string): void;
+/**
+ * Helper function to log the names of a collectible type array.
+ *
+ * @param collectibleTypes The collectible types to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[], name?: string): void;
+/**
+ * Helper function to log a `Color` object.
+ *
+ * @param color The `Color` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logColor(this: void, color: Color, name?: string): void;
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
@@ -22,12 +39,24 @@ export declare function logFlags<T extends BitFlag | BitFlag128>(this: void, fla
  * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */
 export declare function logGameStateFlags(this: void): void;
-export declare function logKColor(this: void, kColor: KColor): void;
+/**
+ * Helper function to log a `KColor` object.
+ *
+ * @param kColor The `KColor` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logKColor(this: void, kColor: KColor, name?: string): void;
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
 export declare function logLevelStateFlags(this: void): void;
-export declare function logMap(this: void, map: Map<AnyNotNil, unknown>): void;
+/**
+ * Helper function to log a TSTL `Map`.
+ *
+ * @param map The TSTL `Map` to log.
+ * @param name Optional. The name of the map, which will be logged before the elements.
+ */
+export declare function logMap(this: void, map: Map<AnyNotNil, unknown>, name?: string): void;
 export declare function logMusic(this: void): void;
 export declare function logPlayerEffects(this: void, player: EntityPlayer): void;
 export declare function logPlayerHealth(this: void, player: EntityPlayer): void;
@@ -42,7 +71,13 @@ export declare function logRoom(this: void): void;
  * particular run.
  */
 export declare function logSeedEffects(this: void): void;
-export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
+/**
+ * Helper function to log a TSTL `Set`.
+ *
+ * @param set The TSTL `Set` to log.
+ * @param name Optional. The name of the set, which will be logged before the elements.
+ */
+export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>, name?: string): void;
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(this: void): void;
 /**
@@ -77,5 +112,13 @@ export declare function logUseFlags(this: void, flags: UseFlag | BitFlags<UseFla
  * the Isaac API).
  */
 export declare function logUserdata(this: void, userdata: unknown): void;
-export declare function logVector(this: void, vector: Vector, round?: boolean): void;
+/**
+ * Helper function to log a `Vector` object.
+ *
+ * @param vector The `Vector` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
+export declare function logVector(this: void, vector: Vector, name?: string, round?: boolean): void;
 //# sourceMappingURL=logMisc.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAMV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAoBtC,kEAAkE;AAClE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAUvE;AAED,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,IAAI,EACV,gBAAgB,EAAE,eAAe,EAAE,GAClC,IAAI,CASN;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAIvD;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GACvC,IAAI,CAEN;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GACvC,IAAI,CAEN;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAG5D;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAItD;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAiBlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAI1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAkBnD;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAkBrE;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAKzC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CA0BvE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CAoBtE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CA2BxC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAiB/C;AAED,wBAAgB,MAAM,CACpB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAC3C,IAAI,CAeN;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAQ1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,OAAO,EACjB,YAAY,SAAI,GACf,IAAI,CAuCN;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAkBhE;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GACnC,IAAI,CAEN;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GACjC,IAAI,CAEN;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoB/D;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAGzE"}
+{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAMV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAoBtC;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAaN;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,IAAI,EACV,gBAAgB,EAAE,eAAe,EAAE,EACnC,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAaN;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAQtE;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GACvC,IAAI,CAEN;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GACvC,IAAI,CAEN;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAG5D;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAGtD;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAiBlD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAQzE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAkBnD;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,EAC5B,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAmBN;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAKzC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CA0BvE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CAoBtE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CA2BxC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAiB/C;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,EAC5C,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAgBN;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAQ1C;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,OAAO,EACjB,YAAY,SAAI,GACf,IAAI,CAuCN;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAkBhE;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GACnC,IAAI,CAEN;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GACjC,IAAI,CAEN;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoB/D;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,UAAQ,GACZ,IAAI,CAON"}

package/dist/src/functions/logMisc.lua

@@ -42,6 +42,7 @@ local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____log = require("src.functions.log")
 local log = ____log.log
+local logAndPrint = ____log.logAndPrint
 local ____playerHealth = require("src.functions.playerHealth")
 local getPlayerHealth = ____playerHealth.getPlayerHealth
 local ____players = require("src.functions.players")
@@ -89,17 +90,30 @@ function ____exports.logFlags(flags, flagEnum, description)
         log("  n/a (no flags)")
     end
 end
---- Helper function to enumerate all of the values in an array.
-function ____exports.logArray(array)
+--- Helper function to log all of the values in an array.
+-- 
+-- @param array The array to log.
+-- @param name Optional. The name of the array, which will be logged before the elements.
+function ____exports.logArray(array, name)
     if not isArray(nil, array, false) then
         log("Tried to log an array, but the given object was not an array.")
         return
     end
     local arrayString = arrayToString(nil, array)
-    log("Array: " .. arrayString)
+    if name == nil then
+        name = "array"
+    end
+    log((("Logging " .. name) .. ": ") .. arrayString)
 end
-function ____exports.logCollectibleTypes(collectibleTypes)
-    log("Collectibles:")
+--- Helper function to log the names of a collectible type array.
+-- 
+-- @param collectibleTypes The collectible types to log.
+-- @param name Optional. The name of the array, which will be logged before the elements.
+function ____exports.logCollectibleTypes(collectibleTypes, name)
+    if name == nil then
+        name = "collectibles"
+    end
+    log(("Logging " .. name) .. ":")
     local i = 1
     for ____, collectibleType in ipairs(collectibleTypes) do
         local collectibleName = getCollectibleName(nil, collectibleType)
@@ -107,8 +121,15 @@ function ____exports.logCollectibleTypes(collectibleTypes)
         i = i + 1
     end
 end
-function ____exports.logColor(color)
-    log((((((((((((("Color: R" .. tostring(color.R)) .. ", G") .. tostring(color.G)) .. ", B") .. tostring(color.B)) .. ", A") .. tostring(color.A)) .. ", RO") .. tostring(color.RO)) .. ", BO") .. tostring(color.BO)) .. ", GO") .. tostring(color.GO))
+--- Helper function to log a `Color` object.
+-- 
+-- @param color The `Color` object to log.
+-- @param name Optional. The name of the object, which will be logged before the properties.
+function ____exports.logColor(color, name)
+    if name == nil then
+        name = "color"
+    end
+    log((((((((((((((("Logging " .. name) .. ": R") .. tostring(color.R)) .. ", G") .. tostring(color.G)) .. ", B") .. tostring(color.B)) .. ", A") .. tostring(color.A)) .. ", RO") .. tostring(color.RO)) .. ", BO") .. tostring(color.BO)) .. ", GO") .. tostring(color.GO))
 end
 --- Helper function for printing out every damage flag that is turned on. Useful when debugging.
 function ____exports.logDamageFlags(flags)
@@ -120,7 +141,7 @@ function ____exports.logEntityFlags(flags)
 end
 function ____exports.logEntityID(entity)
     local entityID = getEntityID(nil, entity)
-    log("Entity: " .. entityID)
+    log("Logging entity: " .. entityID)
 end
 --- Helper function to log an error message and also print it to the console for better visibility.
 -- 
@@ -128,8 +149,7 @@ end
 -- prevents all of the subsequent code in the callback from running).
 function ____exports.logError(msg)
     local errorMsg = "Error: " .. msg
-    log(errorMsg)
-    print(errorMsg)
+    logAndPrint(nil, errorMsg)
 end
 --- Helper function for printing out every game state flag that is turned on. Useful when debugging.
 function ____exports.logGameStateFlags()
@@ -149,8 +169,15 @@ function ____exports.logGameStateFlags()
         log("  n/a (no flags)")
     end
 end
-function ____exports.logKColor(kColor)
-    log((((((("Color: R" .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))
+--- Helper function to log a `KColor` object.
+-- 
+-- @param kColor The `KColor` object to log.
+-- @param name Optional. The name of the object, which will be logged before the properties.
+function ____exports.logKColor(kColor, name)
+    if name == nil then
+        name = "KColor"
+    end
+    log((((((((("Logging " .. name) .. ": R") .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))
 end
 --- Helper function for printing out every level state flag that is turned on. Useful when debugging.
 function ____exports.logLevelStateFlags()
@@ -171,12 +198,17 @@ function ____exports.logLevelStateFlags()
         log("  n/a (no flags)")
     end
 end
-function ____exports.logMap(map)
+--- Helper function to log a TSTL `Map`.
+-- 
+-- @param map The TSTL `Map` to log.
+-- @param name Optional. The name of the map, which will be logged before the elements.
+function ____exports.logMap(map, name)
     if not isTSTLMap(nil, map) and not isDefaultMap(nil, map) then
         log("Tried to log a TSTL map, but the given object was not a TSTL map.")
         return
     end
-    log("Printing out a TSTL map:")
+    local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
+    log(("Printing out a TSTL map" .. suffix) .. ":")
     local mapKeys = {__TS__Spread(map:keys())}
     __TS__ArraySort(mapKeys)
     for ____, key in ipairs(mapKeys) do
@@ -246,7 +278,7 @@ function ____exports.logRoom()
     local roomGridIndex = getRoomGridIndex(nil)
     local roomListIndex = getRoomListIndex(nil)
     local roomData = getRoomData(nil)
-    log("Current room information:")
+    log("Logging room information:")
     if roomData == nil then
         log("- Room data is undefined.")
     else
@@ -282,12 +314,17 @@ function ____exports.logSeedEffects()
         log("  n/a (no seed effects)")
     end
 end
-function ____exports.logSet(set)
+--- Helper function to log a TSTL `Set`.
+-- 
+-- @param set The TSTL `Set` to log.
+-- @param name Optional. The name of the set, which will be logged before the elements.
+function ____exports.logSet(set, name)
     if not isTSTLSet(nil, set) then
         log("Tried to log a TSTL set, but the given object was not a TSTL set.")
         return
     end
-    log("Printing out a TSTL set:")
+    local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
+    log(("Printing out a TSTL set" .. suffix) .. ":")
     local setValues = getSortedSetValues(nil, set)
     for ____, value in ipairs(setValues) do
         log("  Value: " .. tostring(value))
@@ -432,11 +469,20 @@ function ____exports.logUserdata(userdata)
     end
     ____exports.logTable(metatable)
 end
-function ____exports.logVector(vector, round)
+--- Helper function to log a `Vector` object.
+-- 
+-- @param vector The `Vector` object to log.
+-- @param name Optional. The name of the object, which will be logged before the properties.
+-- @param round Optional. If true, will round the vector values to the nearest integer. Default is
+-- false.
+function ____exports.logVector(vector, name, round)
     if round == nil then
         round = false
     end
+    if name == nil then
+        name = "vector"
+    end
     local vectorString = vectorToString(nil, vector, round)
-    log("Vector: " .. vectorString)
+    log((("Logging " .. name) .. ": ") .. vectorString)
 end
 return ____exports

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

@@ -55,5 +55,12 @@ export declare function serializeVector(vector: Vector): SerializedVector;
 export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
+/**
+ * Helper function to convert a vector to a string.
+ *
+ * @param vector The vector to convert.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
 export declare function vectorToString(vector: Vector, round?: boolean): string;
 //# sourceMappingURL=vector.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,QAAQ,CAAC,MAAM,CAAC,CAOlB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,QAAQ,CAAC,MAAM,CAAC,CAOlB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}

package/dist/src/functions/vector.lua

@@ -119,6 +119,11 @@ function ____exports.vectorToDirection(self, vector)
     local angleDegrees = vector:GetAngleDegrees()
     return angleToDirection(nil, angleDegrees)
 end
+--- Helper function to convert a vector to a string.
+-- 
+-- @param vector The vector to convert.
+-- @param round Optional. If true, will round the vector values to the nearest integer. Default is
+-- false.
 function ____exports.vectorToString(self, vector, round)
     if round == nil then
         round = false

package/package.json

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

package/src/functions/logMisc.ts

@@ -21,7 +21,7 @@ import { getEntityID } from "./entities";
 import { getEnumEntries } from "./enums";
 import { hasFlag } from "./flag";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
-import { log } from "./log";
+import { log, logAndPrint } from "./log";
 import { getPlayerHealth } from "./playerHealth";
 import { getEffectsList, getPlayerName } from "./players";
 import { getRoomData, getRoomGridIndex, getRoomListIndex } from "./roomData";
@@ -32,8 +32,17 @@ import { isDefaultMap, isTSTLMap, isTSTLSet } from "./tstlClass";
 import { isTable, isUserdata } from "./types";
 import { vectorToString } from "./vector";
 
-/** Helper function to enumerate all of the values in an array. */
-export function logArray<T>(this: void, array: T[] | readonly T[]): void {
+/**
+ * Helper function to log all of the values in an array.
+ *
+ * @param array The array to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export function logArray<T>(
+  this: void,
+  array: T[] | readonly T[],
+  name?: string,
+): void {
   // We do not assume the given array has contiguous values in order to be more permissive about the
   // kinds of arrays that will successfully log without a run-time error.
   if (!isArray(array, false)) {
@@ -42,14 +51,28 @@ export function logArray<T>(this: void, array: T[] | readonly T[]): void {
   }
 
   const arrayString = arrayToString(array);
-  log(`Array: ${arrayString}`);
+  if (name === undefined) {
+    name = "array";
+  }
+  log(`Logging ${name}: ${arrayString}`);
 }
 
+/**
+ * Helper function to log the names of a collectible type array.
+ *
+ * @param collectibleTypes The collectible types to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
 export function logCollectibleTypes(
   this: void,
   collectibleTypes: CollectibleType[],
+  name?: string,
 ): void {
-  log("Collectibles:");
+  if (name === undefined) {
+    name = "collectibles";
+  }
+
+  log(`Logging ${name}:`);
 
   let i = 1;
   for (const collectibleType of collectibleTypes) {
@@ -59,9 +82,19 @@ export function logCollectibleTypes(
   }
 }
 
-export function logColor(this: void, color: Color): void {
+/**
+ * Helper function to log a `Color` object.
+ *
+ * @param color The `Color` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export function logColor(this: void, color: Color, name?: string): void {
+  if (name === undefined) {
+    name = "color";
+  }
+
   log(
-    `Color: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
+    `Logging ${name}: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
   );
 }
 
@@ -83,7 +116,7 @@ export function logEntityFlags(
 
 export function logEntityID(this: void, entity: Entity): void {
   const entityID = getEntityID(entity);
-  log(`Entity: ${entityID}`);
+  log(`Logging entity: ${entityID}`);
 }
 
 /**
@@ -94,8 +127,7 @@ export function logEntityID(this: void, entity: Entity): void {
  */
 export function logError(this: void, msg: string): void {
   const errorMsg = `Error: ${msg}`;
-  log(errorMsg);
-  print(errorMsg);
+  logAndPrint(errorMsg);
 }
 
 /** Helper function for printing out every flag that is turned on. Useful when debugging. */
@@ -147,9 +179,19 @@ export function logGameStateFlags(this: void): void {
   }
 }
 
-export function logKColor(this: void, kColor: KColor): void {
+/**
+ * Helper function to log a `KColor` object.
+ *
+ * @param kColor The `KColor` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export function logKColor(this: void, kColor: KColor, name?: string): void {
+  if (name === undefined) {
+    name = "KColor";
+  }
+
   log(
-    `Color: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
+    `Logging ${name}: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
   );
 }
 
@@ -176,13 +218,24 @@ export function logLevelStateFlags(this: void): void {
   }
 }
 
-export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
+/**
+ * Helper function to log a TSTL `Map`.
+ *
+ * @param map The TSTL `Map` to log.
+ * @param name Optional. The name of the map, which will be logged before the elements.
+ */
+export function logMap(
+  this: void,
+  map: Map<AnyNotNil, unknown>,
+  name?: string,
+): void {
   if (!isTSTLMap(map) && !isDefaultMap(map)) {
     log("Tried to log a TSTL map, but the given object was not a TSTL map.");
     return;
   }
 
-  log("Printing out a TSTL map:");
+  const suffix = name === undefined ? ` "${name}"` : "";
+  log(`Printing out a TSTL map${suffix}:`);
 
   const mapKeys = [...map.keys()];
   mapKeys.sort();
@@ -271,7 +324,7 @@ export function logRoom(this: void): void {
   const roomListIndex = getRoomListIndex();
   const roomData = getRoomData();
 
-  log("Current room information:");
+  log("Logging room information:");
   if (roomData === undefined) {
     log("- Room data is undefined.");
   } else {
@@ -316,16 +369,24 @@ export function logSeedEffects(this: void): void {
   }
 }
 
+/**
+ * Helper function to log a TSTL `Set`.
+ *
+ * @param set The TSTL `Set` to log.
+ * @param name Optional. The name of the set, which will be logged before the elements.
+ */
 export function logSet(
   this: void,
   set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>,
+  name?: string,
 ): void {
   if (!isTSTLSet(set)) {
     log("Tried to log a TSTL set, but the given object was not a TSTL set.");
     return;
   }
 
-  log("Printing out a TSTL set:");
+  const suffix = name === undefined ? ` "${name}"` : "";
+  log(`Printing out a TSTL set${suffix}:`);
 
   const setValues = getSortedSetValues(set);
   for (const value of setValues) {
@@ -510,7 +571,24 @@ export function logUserdata(this: void, userdata: unknown): void {
   logTable(metatable);
 }
 
-export function logVector(this: void, vector: Vector, round = false): void {
+/**
+ * Helper function to log a `Vector` object.
+ *
+ * @param vector The `Vector` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
+export function logVector(
+  this: void,
+  vector: Vector,
+  name?: string,
+  round = false,
+): void {
+  if (name === undefined) {
+    name = "vector";
+  }
+
   const vectorString = vectorToString(vector, round);
-  log(`Vector: ${vectorString}`);
+  log(`Logging ${name}: ${vectorString}`);
 }

package/src/functions/vector.ts

@@ -151,6 +151,13 @@ export function vectorToDirection(vector: Vector): Direction {
   return angleToDirection(angleDegrees);
 }
 
+/**
+ * Helper function to convert a vector to a string.
+ *
+ * @param vector The vector to convert.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
 export function vectorToString(vector: Vector, round = false): string {
   const x = round ? Math.round(vector.X) : vector.X;
   const y = round ? Math.round(vector.Y) : vector.Y;