Log Misc
Functions
Section titled “Functions”logArray()
Section titled “logArray()”logArray(
this,array,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:55
Helper function to log all of the values in an array.
Parameters
Section titled “Parameters”void
readonly unknown[]
The array to log.
string
Optional. The name of the array, which will be logged before the elements.
Returns
Section titled “Returns”void
logCollectibleTypes()
Section titled “logCollectibleTypes()”logCollectibleTypes(
this,collectibleTypes,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:79
Helper function to log the names of a collectible type array.
Parameters
Section titled “Parameters”void
collectibleTypes
Section titled “collectibleTypes”readonly CollectibleType[]
The collectible types to log.
string
Optional. The name of the array, which will be logged before the elements.
Returns
Section titled “Returns”void
logColor()
Section titled “logColor()”logColor(
this,color,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:102
Helper function to log a Color object.
Parameters
Section titled “Parameters”void
Color
The Color object to log.
string
Optional. The name of the object, which will be logged before the properties.
Returns
Section titled “Returns”void
logDamageFlags()
Section titled “logDamageFlags()”logDamageFlags(
this,damageFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:111
Helper function to log every damage flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
damageFlags
Section titled “damageFlags”DamageFlagValue | BitFlags<DamageFlagValue>
Returns
Section titled “Returns”void
logDisplayFlags()
Section titled “logDisplayFlags()”logDisplayFlags(
this,displayFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:119
Helper function to log every display flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
displayFlags
Section titled “displayFlags”DisplayFlagValue | BitFlags<DisplayFlagValue>
Returns
Section titled “Returns”void
logEntityFlags()
Section titled “logEntityFlags()”logEntityFlags(
this,entityFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:127
Helper function to log every entity flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
entityFlags
Section titled “entityFlags”EntityFlagValue | BitFlags<EntityFlagValue>
Returns
Section titled “Returns”void
logEntityID()
Section titled “logEntityID()”logEntityID(
this,entity):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:134
Parameters
Section titled “Parameters”void
entity
Section titled “entity”Entity
Returns
Section titled “Returns”void
logFlags()
Section titled “logFlags()”logFlags<
T>(this,flags,flagEnum,description?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:140
Helper function for logging every flag that is turned on. Useful when debugging.
Type Parameters
Section titled “Type Parameters”T extends BitFlag | BitFlag128
Parameters
Section titled “Parameters”void
T | BitFlags<T>
flagEnum
Section titled “flagEnum”ReadonlyRecord<string, T>
description?
Section titled “description?”string = ""
Returns
Section titled “Returns”void
logGameStateFlags()
Section titled “logGameStateFlags()”logGameStateFlags(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:170
Helper function for logging every game state flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logItemPoolTypes()
Section titled “logItemPoolTypes()”logItemPoolTypes(
this,itemPoolTypes,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:195
Helper function to log the names of a item pool type array.
Parameters
Section titled “Parameters”void
itemPoolTypes
Section titled “itemPoolTypes”readonly ItemPoolType[]
The item pool types to log.
string
Optional. The name of the array, which will be logged before the elements.
Returns
Section titled “Returns”void
logKColor()
Section titled “logKColor()”logKColor(
this,kColor,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:218
Helper function to log a KColor object.
Parameters
Section titled “Parameters”void
kColor
Section titled “kColor”KColor
The KColor object to log.
string
Optional. The name of the object, which will be logged before the properties.
Returns
Section titled “Returns”void
logLevelStateFlags()
Section titled “logLevelStateFlags()”logLevelStateFlags(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:227
Helper function for logging every level state flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logMap()
Section titled “logMap()”logMap(
this,map,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:253
Helper function to log a TSTL Map.
Parameters
Section titled “Parameters”void
ReadonlyMap<string | number, unknown>
The TSTL Map to log.
string
Optional. The name of the map, which will be logged before the elements.
Returns
Section titled “Returns”void
logMusic()
Section titled “logMusic()”logMusic(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:277
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logPlayerEffects()
Section titled “logPlayerEffects()”logPlayerEffects(
this,player):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:284
Parameters
Section titled “Parameters”void
player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”void
logPlayerHealth()
Section titled “logPlayerHealth()”logPlayerHealth(
this,player):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:315
Parameters
Section titled “Parameters”void
player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”void
logProjectileFlags()
Section titled “logProjectileFlags()”logProjectileFlags(
this,projectileFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:338
Helper function for logging every projectile flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
projectileFlags
Section titled “projectileFlags”ProjectileFlagValue | BitFlags<ProjectileFlagValue>
Returns
Section titled “Returns”void
logRoom()
Section titled “logRoom()”logRoom(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:346
Helper function for logging information about the current room.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logSeedEffects()
Section titled “logSeedEffects()”logSeedEffects(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:378
Helper function for logging every seed effect (i.e. Easter Egg) that is turned on for the particular run.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logSet()
Section titled “logSet()”logSet(
this,set,name?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:405
Helper function to log a TSTL Set.
Parameters
Section titled “Parameters”void
ReadonlySet<string | number>
The TSTL Set to log.
string
Optional. The name of the set, which will be logged before the elements.
Returns
Section titled “Returns”void
logSounds()
Section titled “logSounds()”logSounds(
this):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:427
Helper function for logging every sound effect that is currently playing.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”void
logTable()
Section titled “logTable()”logTable(
this,luaTable,parentTables?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:447
Helper function for logging every key and value of a Lua table. This is a deep log; the function will recursively call itself if it encounters a table within a table.
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.
In order to prevent infinite recursion, this function will not log a sub-table when there are 10 or more parent tables.
Parameters
Section titled “Parameters”void
luaTable
Section titled “luaTable”unknown
parentTables?
Section titled “parentTables?”number = 0
Returns
Section titled “Returns”void
logTableDifferences()
Section titled “logTableDifferences()”logTableDifferences<
K,V>(this,table1,table2):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:496
Helper function to log the differences between the entries of two tables. Note that this will only do a shallow comparison.
Type Parameters
Section titled “Type Parameters”K extends AnyNotNil
V
Parameters
Section titled “Parameters”void
table1
Section titled “table1”LuaMap<K, V>
table2
Section titled “table2”LuaMap<K, V>
Returns
Section titled “Returns”void
logTableKeys()
Section titled “logTableKeys()”logTableKeys(
this,luaTable):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:540
Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the top-most table will be logged.
This function is useful for tables that have recursive references.
Parameters
Section titled “Parameters”void
luaTable
Section titled “luaTable”unknown
Returns
Section titled “Returns”void
logTableShallow()
Section titled “logTableShallow()”logTableShallow<
K,V>(this,luaTable):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:567
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.
Type Parameters
Section titled “Type Parameters”K extends AnyNotNil
V
Parameters
Section titled “Parameters”void
luaTable
Section titled “luaTable”LuaMap<K, V>
Returns
Section titled “Returns”void
logTearFlags()
Section titled “logTearFlags()”logTearFlags(
this,tearFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:594
Helper function for log every tear flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
tearFlags
Section titled “tearFlags”TearFlagValue | BitFlags<TearFlagValue>
Returns
Section titled “Returns”void
logUseFlags()
Section titled “logUseFlags()”logUseFlags(
this,useFlags):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:602
Helper function for printing out every use flag that is turned on. Useful when debugging.
Parameters
Section titled “Parameters”void
useFlags
Section titled “useFlags”UseFlagValue | BitFlags<UseFlagValue>
Returns
Section titled “Returns”void
logUserdata()
Section titled “logUserdata()”logUserdata(
this,userdata):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:613
Helper function to enumerate all of the properties of a “userdata” object (i.e. an object from the Isaac API).
Parameters
Section titled “Parameters”void
userdata
Section titled “userdata”unknown
Returns
Section titled “Returns”void
logVector()
Section titled “logVector()”logVector(
this,vector,name?,round?):void
Defined in: packages/isaacscript-common/src/functions/logMisc.ts:643
Helper function to log a Vector object.
Parameters
Section titled “Parameters”void
vector
Section titled “vector”Vector
The Vector object to log.
string
Optional. The name of the object, which will be logged before the properties.
round?
Section titled “round?”boolean = false
Optional. If true, will round the vector values to the nearest integer. Default is false.
Returns
Section titled “Returns”void