Isaac API Class
Functions
Section titled “Functions”getIsaacAPIClassName()
Section titled “getIsaacAPIClassName()”getIsaacAPIClassName(
object):string|undefined
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:17
Helper function to get the name of a class from the Isaac API. This is contained within the “__type” metatable key.
For example, a Vector class is has a name of “Vector”.
Returns undefined if the object is not of type userdata or if the “__type” metatable key does
not exist.
In some cases, Isaac classes can be a read-only. If this is the case, the “__type” field will be prepended with “const “. This function will always strip this prefix, if it exists. For example, the class name returned for “const Vector” will be “Vector”.
Parameters
Section titled “Parameters”object
Section titled “object”unknown
Returns
Section titled “Returns”string | undefined
isaacAPIClassEquals()
Section titled “isaacAPIClassEquals()”isaacAPIClassEquals(
object1,object2,keys):boolean
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:40
Helper function to check if an instantiated Isaac API class is equal to another one of the same type. You must provide the list of keys to check for.
Parameters
Section titled “Parameters”object1
Section titled “object1”unknown
object2
Section titled “object2”unknown
readonly string[]
Returns
Section titled “Returns”boolean
isBomb()
Section titled “isBomb()”isBomb(
variable):variable is EntityBomb
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:52
Helper function to detect if a variable is of type EntityBomb.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityBomb
isDoor()
Section titled “isDoor()”isDoor(
variable):variable is GridEntityDoor
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:57
Helper function to detect if a variable is of type GridEntityDoor.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityDoor
isEffect()
Section titled “isEffect()”isEffect(
variable):variable is EntityEffect
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:62
Helper function to detect if a variable is of type EntityEffect.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityEffect
isEntity()
Section titled “isEntity()”isEntity(
variable):variable is Entity
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:70
Helper function to detect if a variable is of type Entity. This will return false for child
classes such as EntityPlayer or EntityTear.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is Entity
isFamiliar()
Section titled “isFamiliar()”isFamiliar(
variable):variable is EntityFamiliar
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:75
Helper function to detect if a variable is of type EntityFamiliar.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityFamiliar
isGridEntity()
Section titled “isGridEntity()”isGridEntity(
variable):variable is GridEntity
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:80
Helper function to detect if a variable is of type GridEntity.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntity
isIsaacAPIClass()
Section titled “isIsaacAPIClass()”isIsaacAPIClass(
object):object is IsaacAPIClass
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:89
Helper function to check if something is an instantiated class from the Isaac API. (All classes from the Isaac API have a type of “userdata” in Lua with a metatable key of “__type” equal to the name of the class.)
Parameters
Section titled “Parameters”object
Section titled “object”unknown
Returns
Section titled “Returns”object is IsaacAPIClass
isIsaacAPIClassOfType()
Section titled “isIsaacAPIClassOfType()”isIsaacAPIClassOfType(
object,classType):boolean
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:94
Parameters
Section titled “Parameters”object
Section titled “object”unknown
classType
Section titled “classType”string
Returns
Section titled “Returns”boolean
isKnife()
Section titled “isKnife()”isKnife(
variable):variable is EntityKnife
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:106
Helper function to detect if a variable is of type EntityKnife.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityKnife
isLaser()
Section titled “isLaser()”isLaser(
variable):variable is EntityLaser
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:111
Helper function to detect if a variable is of type EntityLaser.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityLaser
isNPC()
Section titled “isNPC()”isNPC(
variable):variable is EntityNPC
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:116
Helper function to detect if a variable is of type EntityNPC.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityNPC
isPickup()
Section titled “isPickup()”isPickup(
variable):variable is EntityPickup
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:121
Helper function to detect if a variable is of type EntityPickup.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityPickup
isPit()
Section titled “isPit()”isPit(
variable):variable is GridEntityPit
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:126
Helper function to detect if a variable is of type GridEntityPit.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityPit
isPlayer()
Section titled “isPlayer()”isPlayer(
variable):variable is EntityPlayer
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:131
Helper function to detect if a variable is of type EntityPlayer.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityPlayer
isPoop()
Section titled “isPoop()”isPoop(
variable):variable is GridEntityPoop
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:136
Helper function to detect if a variable is of type GridEntityPoop.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityPoop
isPressurePlate()
Section titled “isPressurePlate()”isPressurePlate(
variable):variable is GridEntityPressurePlate
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:141
Helper function to detect if a variable is of type GridEntityPressurePlate.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityPressurePlate
isProjectile()
Section titled “isProjectile()”isProjectile(
variable):variable is EntityProjectile
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:148
Helper function to detect if a variable is of type EntityProjectile.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityProjectile
isRock()
Section titled “isRock()”isRock(
variable):variable is GridEntityRock
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:153
Helper function to detect if a variable is of type GridEntityRock.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityRock
isSpikes()
Section titled “isSpikes()”isSpikes(
variable):variable is GridEntitySpikes
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:158
Helper function to detect if a variable is of type GridEntitySpikes.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntitySpikes
isTear()
Section titled “isTear()”isTear(
variable):variable is EntityTear
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:163
Helper function to detect if a variable is of type EntityTear.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is EntityTear
isTNT()
Section titled “isTNT()”isTNT(
variable):variable is GridEntityTNT
Defined in: packages/isaacscript-common/src/functions/isaacAPIClass.ts:168
Helper function to detect if a variable is of type GridEntityTNT.
Parameters
Section titled “Parameters”variable
Section titled “variable”unknown
Returns
Section titled “Returns”variable is GridEntityTNT