isaacscript-common 30.11.5 → 30.11.7

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. */