isaacscript-common 30.11.5 → 30.11.6

package/dist/index.rollup.d.ts

@@ -9067,10 +9067,10 @@ export declare function logCollectibleTypes(this: void, collectibleTypes: Collec
  */
 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. */
+/** Helper function to log 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 display flag that is turned on. Useful when debugging. */
+/** Helper function to log every display flag that is turned on. Useful when debugging. */
 export declare function logDisplayFlags(this: void, flags: DisplayFlag | BitFlags<DisplayFlag>): void;
 
 /** Helper function for logging an array of specific entities. */
@@ -9079,7 +9079,7 @@ export declare function logEntities(this: void, entities: Entity[]): void;
 /** Helper function to log information about a specific entity. */
 export declare function logEntity(this: void, entity: Entity): void;
 
-/** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
+/** Helper function to log every entity flag that is turned on. Useful when debugging. */
 export declare function logEntityFlags(this: void, flags: EntityFlag | BitFlags<EntityFlag>): void;
 
 export declare function logEntityID(this: void, entity: Entity): void;
@@ -9092,12 +9092,10 @@ export declare function logEntityID(this: void, entity: Entity): void;
  */
 export declare function logError(this: void, msg: string): void;
 
-/** Helper function for printing out every flag that is turned on. Useful when debugging. */
+/** Helper function for logging every flag that is turned on. Useful when debugging. */
 export declare function logFlags<T extends BitFlag | BitFlag128>(this: void, flags: T | BitFlags<T>, flagEnum: Record<string, T>, description?: string): void;
 
-/**
- * Helper function for printing out every game state flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every game state flag that is turned on. Useful when debugging. */
 export declare function logGameStateFlags(this: void): void;
 
 /** Helper function for logging an array of specific grid entities. */
@@ -9114,9 +9112,7 @@ export declare function logGridEntity(this: void, gridEntity: GridEntity): void;
  */
 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.
- */
+/** Helper function for logging every level state flag that is turned on. Useful when debugging. */
 export declare function logLevelStateFlags(this: void): void;
 
 /**
@@ -9135,9 +9131,7 @@ export declare function logPlayerEffects(this: void, player: EntityPlayer): void
 
 export declare function logPlayerHealth(this: void, player: EntityPlayer): void;
 
-/**
- * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every projectile flag that is turned on. Useful when debugging. */
 export declare function logProjectileFlags(this: void, flags: ProjectileFlag | BitFlags<ProjectileFlag>): void;
 
 /**
@@ -9156,7 +9150,7 @@ export declare function logPtrHashes(this: void, ptrHashes: PtrHash[]): void;
 export declare function logRoom(this: void): void;
 
 /**
- * Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
+ * Helper function for logging every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
 export declare function logSeedEffects(this: void): void;
@@ -9185,8 +9179,8 @@ export declare function logSounds(this: void): void;
 export declare function logTable(this: void, luaTable: unknown, parentTables?: number): void;
 
 /**
- * Helper function to print out the differences between the entries of two tables. Note that this
- * will only do a shallow comparison.
+ * Helper function to log the differences between the entries of two tables. Note that this will
+ * only do a shallow comparison.
  */
 export declare function logTableDifferences<K extends AnyNotNil, V>(this: void, table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
 
@@ -9198,7 +9192,16 @@ export declare function logTableDifferences<K extends AnyNotNil, V>(this: void,
  */
 export declare function logTableKeys(this: void, luaTable: unknown): void;
 
-/** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
+/**
+ * Helper function to log every table key and value. This is a shallow log; the function will not
+ * recursively traverse sub-tables.
+ *
+ * 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 declare function logTableShallow<K extends AnyNotNil, V>(this: void, luaTable: LuaMap<K, V>): void;
+
+/** Helper function for log every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(this: void, flags: TearFlag | BitFlags<TearFlag>): void;
 
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 30.11.5
+isaacscript-common 30.11.6
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -29411,7 +29411,7 @@ function ____exports.logMap(map, name)
         return
     end
     local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
-    log(("Printing out a TSTL map" .. suffix) .. ":")
+    log(("Logging a TSTL map" .. suffix) .. ":")
     local mapKeys = {__TS__Spread(map:keys())}
     __TS__ArraySort(mapKeys)
     for ____, key in ipairs(mapKeys) do
@@ -29519,7 +29519,7 @@ function ____exports.logSet(set, name)
         return
     end
     local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
-    log(("Printing out a TSTL set" .. suffix) .. ":")
+    log(("Logging a TSTL set" .. suffix) .. ":")
     local setValues = getSortedSetValues(nil, set)
     for ____, value in ipairs(setValues) do
         log("  Value: " .. tostring(value))
@@ -29541,7 +29541,7 @@ function ____exports.logTable(luaTable, parentTables)
         parentTables = 0
     end
     if parentTables == 0 then
-        log("Printing out a Lua table:", false)
+        log("Logging a Lua table:", false)
     elseif parentTables > 10 then
         return
     end
@@ -29605,7 +29605,7 @@ function ____exports.logTableDifferences(table1, table2)
     end
 end
 function ____exports.logTableKeys(luaTable)
-    log("Printing out the keys of a Lua table:")
+    log("Logging the keys of a Lua table:")
     if not isTable(nil, luaTable) then
         log(("  n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)")
         return
@@ -29621,6 +29621,33 @@ function ____exports.logTableKeys(luaTable)
     )
     log("  The size of the table was: " .. tostring(numElements))
 end
+function ____exports.logTableShallow(luaTable)
+    log("Logging a Lua table (shallow):", false)
+    if not isTable(nil, luaTable) then
+        log(
+            ("n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)",
+            false
+        )
+        return
+    end
+    local numElements = 0
+    local indentation = "  "
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key, value)
+            log(
+                ((indentation .. tostring(key)) .. " --> ") .. tostring(value),
+                false
+            )
+            numElements = numElements + 1
+        end
+    )
+    log(
+        (indentation .. "The size of the table was: ") .. tostring(numElements),
+        false
+    )
+end
 function ____exports.logTearFlags(flags)
     ____exports.logFlags(flags, TearFlag, "tear")
 end

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

@@ -21,11 +21,11 @@ export declare function logCollectibleTypes(this: void, collectibleTypes: Collec
  * @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. */
+/** Helper function to log 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 display flag that is turned on. Useful when debugging. */
+/** Helper function to log every display flag that is turned on. Useful when debugging. */
 export declare function logDisplayFlags(this: void, flags: DisplayFlag | BitFlags<DisplayFlag>): void;
-/** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
+/** Helper function to log every entity flag that is turned on. Useful when debugging. */
 export declare function logEntityFlags(this: void, flags: EntityFlag | BitFlags<EntityFlag>): void;
 export declare function logEntityID(this: void, entity: Entity): void;
 /**
@@ -35,11 +35,9 @@ export declare function logEntityID(this: void, entity: Entity): void;
  * prevents all of the subsequent code in the callback from running).
  */
 export declare function logError(this: void, msg: string): void;
-/** Helper function for printing out every flag that is turned on. Useful when debugging. */
+/** Helper function for logging every flag that is turned on. Useful when debugging. */
 export declare function logFlags<T extends BitFlag | BitFlag128>(this: void, flags: T | BitFlags<T>, flagEnum: Record<string, T>, description?: string): void;
-/**
- * Helper function for printing out every game state flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every game state flag that is turned on. Useful when debugging. */
 export declare function logGameStateFlags(this: void): void;
 /**
  * Helper function to log a `KColor` object.
@@ -48,9 +46,7 @@ export declare function logGameStateFlags(this: void): void;
  * @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.
- */
+/** Helper function for logging every level state flag that is turned on. Useful when debugging. */
 export declare function logLevelStateFlags(this: void): void;
 /**
  * Helper function to log a TSTL `Map`.
@@ -62,14 +58,12 @@ export declare function logMap(this: void, map: Map<AnyNotNil, unknown>, name?:
 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;
-/**
- * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every projectile flag that is turned on. Useful when debugging. */
 export declare function logProjectileFlags(this: void, flags: ProjectileFlag | BitFlags<ProjectileFlag>): void;
 /** Helper function for logging information about the current room. */
 export declare function logRoom(this: void): void;
 /**
- * Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
+ * Helper function for logging every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
 export declare function logSeedEffects(this: void): void;
@@ -94,8 +88,8 @@ export declare function logSounds(this: void): void;
  */
 export declare function logTable(this: void, luaTable: unknown, parentTables?: number): void;
 /**
- * Helper function to print out the differences between the entries of two tables. Note that this
- * will only do a shallow comparison.
+ * Helper function to log the differences between the entries of two tables. Note that this will
+ * only do a shallow comparison.
  */
 export declare function logTableDifferences<K extends AnyNotNil, V>(this: void, table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
 /**
@@ -105,7 +99,15 @@ export declare function logTableDifferences<K extends AnyNotNil, V>(this: void,
  * This function is useful for tables that have recursive references.
  */
 export declare function logTableKeys(this: void, luaTable: unknown): void;
-/** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
+/**
+ * Helper function to log every table key and value. This is a shallow log; the function will not
+ * recursively traverse sub-tables.
+ *
+ * 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 declare function logTableShallow<K extends AnyNotNil, V>(this: void, luaTable: LuaMap<K, V>): void;
+/** Helper function for log every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(this: void, flags: TearFlag | BitFlags<TearFlag>): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
 export declare function logUseFlags(this: void, flags: UseFlag | BitFlags<UseFlag>): void;

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,WAAW,EACX,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,oGAAoG;AACpG,wBAAgB,eAAe,CAC7B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,GACzC,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"}
+{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,WAAW,EACX,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,yFAAyF;AACzF,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GACvC,IAAI,CAEN;AAED,0FAA0F;AAC1F,wBAAgB,eAAe,CAC7B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,GACzC,IAAI,CAEN;AAED,yFAAyF;AACzF,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,uFAAuF;AACvF,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,kGAAkG;AAClG,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,mGAAmG;AACnG,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,kGAAkG;AAClG,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;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACpD,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACrB,IAAI,CAqBN;AAED,wFAAwF;AACxF,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

@@ -69,7 +69,7 @@ local isTable = ____types.isTable
 local isUserdata = ____types.isUserdata
 local ____vector = require("src.functions.vector")
 local vectorToString = ____vector.vectorToString
---- Helper function for printing out every flag that is turned on. Useful when debugging.
+--- Helper function for logging every flag that is turned on. Useful when debugging.
 function ____exports.logFlags(flags, flagEnum, description)
     if description == nil then
         description = ""
@@ -132,15 +132,15 @@ function ____exports.logColor(color, name)
     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.
+--- Helper function to log every damage flag that is turned on. Useful when debugging.
 function ____exports.logDamageFlags(flags)
     ____exports.logFlags(flags, DamageFlag, "damage")
 end
---- Helper function for printing out every display flag that is turned on. Useful when debugging.
+--- Helper function to log every display flag that is turned on. Useful when debugging.
 function ____exports.logDisplayFlags(flags)
     ____exports.logFlags(flags, DisplayFlag, "display")
 end
---- Helper function for printing out every entity flag that is turned on. Useful when debugging.
+--- Helper function to log every entity flag that is turned on. Useful when debugging.
 function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
 end
@@ -156,7 +156,7 @@ function ____exports.logError(msg)
     local errorMsg = "Error: " .. msg
     logAndPrint(nil, errorMsg)
 end
---- Helper function for printing out every game state flag that is turned on. Useful when debugging.
+--- Helper function for logging every game state flag that is turned on. Useful when debugging.
 function ____exports.logGameStateFlags()
     log("Logging game state flags:")
     local gameStateFlagEntries = getEnumEntries(nil, GameStateFlag)
@@ -184,7 +184,7 @@ function ____exports.logKColor(kColor, name)
     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.
+--- Helper function for logging every level state flag that is turned on. Useful when debugging.
 function ____exports.logLevelStateFlags()
     local level = game:GetLevel()
     local levelStateFlagEntries = getEnumEntries(nil, LevelStateFlag)
@@ -213,7 +213,7 @@ function ____exports.logMap(map, name)
         return
     end
     local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
-    log(("Printing out a TSTL map" .. suffix) .. ":")
+    log(("Logging a TSTL map" .. suffix) .. ":")
     local mapKeys = {__TS__Spread(map:keys())}
     __TS__ArraySort(mapKeys)
     for ____, key in ipairs(mapKeys) do
@@ -272,7 +272,7 @@ function ____exports.logPlayerHealth(player)
     end
     log("  ]")
 end
---- Helper function for printing out every projectile flag that is turned on. Useful when debugging.
+--- Helper function for logging every projectile flag that is turned on. Useful when debugging.
 function ____exports.logProjectileFlags(flags)
     ____exports.logFlags(flags, ProjectileFlag, "projectile")
 end
@@ -300,7 +300,7 @@ function ____exports.logRoom()
     log("- List index: " .. tostring(roomListIndex))
     log("- Boss ID: " .. tostring(bossID))
 end
---- Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
+--- Helper function for logging every seed effect (i.e. Easter Egg) that is turned on for the
 -- particular run.
 function ____exports.logSeedEffects()
     local seeds = game:GetSeeds()
@@ -329,7 +329,7 @@ function ____exports.logSet(set, name)
         return
     end
     local suffix = name == nil and (" \"" .. tostring(name)) .. "\"" or ""
-    log(("Printing out a TSTL set" .. suffix) .. ":")
+    log(("Logging a TSTL set" .. suffix) .. ":")
     local setValues = getSortedSetValues(nil, set)
     for ____, value in ipairs(setValues) do
         log("  Value: " .. tostring(value))
@@ -360,7 +360,7 @@ function ____exports.logTable(luaTable, parentTables)
         parentTables = 0
     end
     if parentTables == 0 then
-        log("Printing out a Lua table:", false)
+        log("Logging a Lua table:", false)
     elseif parentTables > 10 then
         return
     end
@@ -400,8 +400,8 @@ function ____exports.logTable(luaTable, parentTables)
         false
     )
 end
---- Helper function to print out the differences between the entries of two tables. Note that this
--- will only do a shallow comparison.
+--- Helper function to log the differences between the entries of two tables. Note that this will
+-- only do a shallow comparison.
 function ____exports.logTableDifferences(table1, table2)
     log("Comparing two Lua tables:")
     local table1Keys = __TS__ObjectKeys(table1)
@@ -430,7 +430,7 @@ end
 -- 
 -- This function is useful for tables that have recursive references.
 function ____exports.logTableKeys(luaTable)
-    log("Printing out the keys of a Lua table:")
+    log("Logging the keys of a Lua table:")
     if not isTable(nil, luaTable) then
         log(("  n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)")
         return
@@ -446,7 +446,39 @@ function ____exports.logTableKeys(luaTable)
     )
     log("  The size of the table was: " .. tostring(numElements))
 end
---- Helper function for printing out every tear flag that is turned on. Useful when debugging.
+--- Helper function to log every table key and value. This is a shallow log; the function will not
+-- recursively traverse sub-tables.
+-- 
+-- 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.
+function ____exports.logTableShallow(luaTable)
+    log("Logging a Lua table (shallow):", false)
+    if not isTable(nil, luaTable) then
+        log(
+            ("n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)",
+            false
+        )
+        return
+    end
+    local numElements = 0
+    local indentation = "  "
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key, value)
+            log(
+                ((indentation .. tostring(key)) .. " --> ") .. tostring(value),
+                false
+            )
+            numElements = numElements + 1
+        end
+    )
+    log(
+        (indentation .. "The size of the table was: ") .. tostring(numElements),
+        false
+    )
+end
+--- Helper function for log every tear flag that is turned on. Useful when debugging.
 function ____exports.logTearFlags(flags)
     ____exports.logFlags(flags, TearFlag, "tear")
 end

package/package.json

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

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

@@ -48,7 +48,7 @@ function getAllSaveDataToWriteToDisk(
       };
 
       // If there is no data, then we can move on to the next feature.
-      if (isTableEmpty(saveDataWithoutRoom as LuaTable<AnyNotNil, unknown>)) {
+      if (isTableEmpty(saveDataWithoutRoom as LuaMap<AnyNotNil, unknown>)) {
         return;
       }
 

package/src/decorators.ts

@@ -14,7 +14,7 @@ export function Exported<Class extends Feature>(
 ): void {
   // Since the decorator runs prior to instantiation, we only have access to get and set static
   // properties, which are located on the "constructor" table.
-  const constructor = target.constructor as unknown as LuaTable<
+  const constructor = target.constructor as unknown as LuaMap<
     AnyNotNil,
     unknown
   >;

package/src/functions/decorators.ts

@@ -96,7 +96,7 @@ export function PriorityCallback<T extends ModCallback>(
     // properties, which are located on the "constructor" table. Thus, we store the callback
     // arguments for later.
     const constructor = target.constructor as unknown as
-      | LuaTable<AnyNotNil, unknown>
+      | LuaMap<AnyNotNil, unknown>
       | undefined;
 
     if (constructor === undefined) {
@@ -146,7 +146,7 @@ export function PriorityCallbackCustom<T extends ModCallbackCustom>(
     // properties, which are located on the "constructor" table. Thus, we store the callback
     // arguments for later.
     const constructor = target.constructor as unknown as
-      | LuaTable<AnyNotNil, unknown>
+      | LuaMap<AnyNotNil, unknown>
       | undefined;
 
     if (constructor === undefined) {

package/src/functions/logMisc.ts

@@ -99,7 +99,7 @@ export function logColor(this: void, color: Color, name?: string): void {
   );
 }
 
-/** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
+/** Helper function to log every damage flag that is turned on. Useful when debugging. */
 export function logDamageFlags(
   this: void,
   flags: DamageFlag | BitFlags<DamageFlag>,
@@ -107,7 +107,7 @@ export function logDamageFlags(
   logFlags(flags, DamageFlag, "damage");
 }
 
-/** Helper function for printing out every display flag that is turned on. Useful when debugging. */
+/** Helper function to log every display flag that is turned on. Useful when debugging. */
 export function logDisplayFlags(
   this: void,
   flags: DisplayFlag | BitFlags<DisplayFlag>,
@@ -115,7 +115,7 @@ export function logDisplayFlags(
   logFlags(flags, DisplayFlag, "display");
 }
 
-/** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
+/** Helper function to log every entity flag that is turned on. Useful when debugging. */
 export function logEntityFlags(
   this: void,
   flags: EntityFlag | BitFlags<EntityFlag>,
@@ -139,7 +139,7 @@ export function logError(this: void, msg: string): void {
   logAndPrint(errorMsg);
 }
 
-/** Helper function for printing out every flag that is turned on. Useful when debugging. */
+/** Helper function for logging every flag that is turned on. Useful when debugging. */
 export function logFlags<T extends BitFlag | BitFlag128>(
   this: void,
   flags: T | BitFlags<T>,
@@ -166,9 +166,7 @@ export function logFlags<T extends BitFlag | BitFlag128>(
   }
 }
 
-/**
- * Helper function for printing out every game state flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every game state flag that is turned on. Useful when debugging. */
 export function logGameStateFlags(this: void): void {
   log("Logging game state flags:");
 
@@ -204,9 +202,7 @@ export 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.
- */
+/** Helper function for logging every level state flag that is turned on. Useful when debugging. */
 export function logLevelStateFlags(this: void): void {
   const level = game.GetLevel();
 
@@ -244,7 +240,7 @@ export function logMap(
   }
 
   const suffix = name === undefined ? ` "${name}"` : "";
-  log(`Printing out a TSTL map${suffix}:`);
+  log(`Logging a TSTL map${suffix}:`);
 
   const mapKeys = [...map.keys()];
   mapKeys.sort();
@@ -315,9 +311,7 @@ export function logPlayerHealth(this: void, player: EntityPlayer): void {
   log("  ]");
 }
 
-/**
- * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
- */
+/** Helper function for logging every projectile flag that is turned on. Useful when debugging. */
 export function logProjectileFlags(
   this: void,
   flags: ProjectileFlag | BitFlags<ProjectileFlag>,
@@ -356,7 +350,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
+ * Helper function for logging every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
 export function logSeedEffects(this: void): void {
@@ -395,7 +389,7 @@ export function logSet(
   }
 
   const suffix = name === undefined ? ` "${name}"` : "";
-  log(`Printing out a TSTL set${suffix}:`);
+  log(`Logging a TSTL set${suffix}:`);
 
   const setValues = getSortedSetValues(set);
   for (const value of setValues) {
@@ -433,7 +427,7 @@ export function logTable(
   parentTables = 0,
 ): void {
   if (parentTables === 0) {
-    log("Printing out a Lua table:", false);
+    log("Logging a Lua table:", false);
   } else if (parentTables > 10) {
     return;
   }
@@ -473,8 +467,8 @@ export function logTable(
 }
 
 /**
- * Helper function to print out the differences between the entries of two tables. Note that this
- * will only do a shallow comparison.
+ * Helper function to log the differences between the entries of two tables. Note that this will
+ * only do a shallow comparison.
  */
 export function logTableDifferences<K extends AnyNotNil, V>(
   this: void,
@@ -519,7 +513,7 @@ export function logTableDifferences<K extends AnyNotNil, V>(
  * This function is useful for tables that have recursive references.
  */
 export function logTableKeys(this: void, luaTable: unknown): void {
-  log("Printing out the keys of a Lua table:");
+  log("Logging the keys of a Lua table:");
 
   if (!isTable(luaTable)) {
     log(
@@ -538,7 +532,40 @@ export function logTableKeys(this: void, luaTable: unknown): void {
   log(`  The size of the table was: ${numElements}`);
 }
 
-/** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
+/**
+ * Helper function to log every table key and value. This is a shallow log; the function will not
+ * recursively traverse sub-tables.
+ *
+ * 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 logTableShallow<K extends AnyNotNil, V>(
+  this: void,
+  luaTable: LuaMap<K, V>,
+): void {
+  log("Logging a Lua table (shallow):", false);
+
+  if (!isTable(luaTable)) {
+    log(
+      `n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
+      false,
+    );
+
+    return;
+  }
+
+  let numElements = 0;
+  const indentation = "  ";
+  iterateTableInOrder(luaTable, (key, value) => {
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    log(`${indentation}${key} --> ${value}`, false);
+    numElements++;
+  });
+
+  log(`${indentation}The size of the table was: ${numElements}`, false);
+}
+
+/** Helper function for log every tear flag that is turned on. Useful when debugging. */
 export function logTearFlags(
   this: void,
   flags: TearFlag | BitFlags<TearFlag>,