Class "Entity"⚓︎

Children Classes⚓︎

EntityBomb, EntityEffect, EntityFamiliar, EntityKnife, EntityLaser, EntityNPC, EntityPickup, EntityPlayer, EntityProjectile, EntityTear

Functions⚓︎

Add·Burn ()⚓︎

void AddBurn ( EntityRef Source, int Duration, float Damage )⚓︎

Adds a burn-effect to an enemy. Duration is in Number of Frames. Damage is the Damage taken per frame.

Duration infos

The Duration must be a minimum of 2 frames. Every consecutive damage tick is 20 frames apart.

Damage-ticks = 22 frames
= 42
= 62
...

Bug

Changing the Damage value doesnt seem to have an effect. It always deals the amount of damage of the player.

The Duration value seems to have an upper limit. For a PlayerEntity, its only lasting for the duration of one damage interval. For Entities its up to 6 damage-intervals.

Example Code

This code damages every entity in the room for 1 second with the damagesource set to the player. The total damage dealt is 1.

local player =Isaac.GetPlayer(0)
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddBurn(EntityRef(player), 30, 1)
end

Add·Charmed ()⚓︎

void AddCharmed ( int Duration )⚓︎

Adds a charmed-effect to an enemy. Duration is in Number of Frames. Charmed enemies are friendly towards isaac and attack other enemies.

AddCharmed(-1) makes the effect permanent and the enemy will follow you even to different rooms.

Example Code

This code charms every entity in the room for 1 second.

for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddCharmed(30)
end

Add·Confusion ()⚓︎

void AddConfusion ( EntityRef Source, int Duration, boolean IgnoreBosses )⚓︎

Adds a confusion effect to an entity.

Duration infos

The Duration has a maximum of 5 seconds

Example Code

This code confuses every entity in the room for 1 second while ignoring bosses.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddConfusion(EntityRef(player), 30, true)
end

Add·Entity·Flags ()⚓︎

void AddEntityFlags ( int Flags )⚓︎

Add EntityFlags to the entity. Flags are used to add specific effects like poisoning or freeze. You can add multiple flags at the same time by bitwise-concatenating them.

Example Code

This code adds slowing and confusion to the enetity.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddEntityFlags(EntityFlag.FLAG_SLOW | EntityFlag.FLAG_CONFUSION)
end

Add·Fear ()⚓︎

void AddFear ( EntityRef Source, int Duration )⚓︎

Adds a fear-effect to an entity.

Duration infos

The Duration has a maximum of 5 seconds

Example Code

This code frightens every entity in the room for 1 second.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddFear(EntityRef(player), 30)
end

Add·Freeze ()⚓︎

void AddFreeze ( EntityRef Source, int Duration )⚓︎

Freezes an entity, making it unable to move and attack.

Duration infos

The Duration has a maximum of 5 seconds

Example Code

This code freezes every entity in the room for 1 second.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddFreeze(EntityRef(player), 30)
end

Add·Health ()⚓︎

void AddHealth ( float HitPoints )⚓︎

Heals an entity.

Add·Midas·Freeze ()⚓︎

void AddMidasFreeze ( EntityRef Source, int Duration )⚓︎

Turns the entity into a gold statue (can't move, can't attack, drops coins when killed)

Duration infos

The Duration has a maximum of 5 seconds

Bug

The golden color applied to the entity will stay for the full duration passed into the function, despite the freeze effect only lasting for a maximum of 5 seconds.

Example Code

This code turns every entity in the room into gold for 1 second.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddMidasFreeze(EntityRef(player), 30)
end

Add·Poison ()⚓︎

void AddPoison ( EntityRef Source, int Duration, float Damage )⚓︎

Adds a poison effect to the entity.

Duration infos

The Duration must be a minimum of 2 frames. Every consecutive damage tick is 20 frames apart.

Damage-ticks = 22 frames
= 42
= 62
...

Bug

Changing the Damage value doesnt seem to have an effect. It always deals the amount of damage of the player.

The Duration value seems to have an upper limit. For a PlayerEntity, its only lasting for the duration of one damage interval. For Entities its up to 6 damage-intervals.

Example Code

This code applies a poison effect to every entity in the room for 1 second.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddPoison(EntityRef(player), 30, 1)
end

Add·Shrink ()⚓︎

void AddShrink ( EntityRef Source, int Duration )⚓︎

Adds a shrink effect to the entity.

Duration infos

The Duration has a maximum of 5 seconds

Example Code

This code shrinks every entity in the room for 1 second.

local player =Isaac.GetPlayer(0) 
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddShrink(EntityRef(player), 30)
end

Add·Slowing ()⚓︎

void AddSlowing ( EntityRef Source, int Duration, float SlowValue, Color SlowColor )⚓︎

Makes the friction higher effectively slowing down the entity.

Example Code

This code slows every entity in the room for 1 second with 0.5 original speed and applying a red color to it.

local player =Isaac.GetPlayer(0) 
local slowColor = Color(1, 0, 0, 1, 0, 0, 0)
for i, entity in ipairs(Isaac.GetRoomEntities()) do
    entity:AddSlowing(EntityRef(player), 30, 0.5, slowColor)
end

Add·Velocity ()⚓︎

void AddVelocity ( Vector Velocity )⚓︎

Adds velocity to the entity. This can be used to move him in a certain direktion (for example as a result of collision)

Blood·Explode ()⚓︎

void BloodExplode ( )⚓︎

Explodes with gibs and blood.

Can·Shut·Doors ()⚓︎

boolean CanShutDoors ( )⚓︎

enemies keep the doors shut.

Clear·Entity·Flags ()⚓︎

void ClearEntityFlags ( int Flags )⚓︎

Removes all EntityFlags from the entity.

Collides·With·Grid ()⚓︎

boolean CollidesWithGrid ( )⚓︎

Returns true, if the entity is able to collide with the grid.

Die ()⚓︎

void Die ( )⚓︎

Kills the entity and trigger its death animation.

Exists ()⚓︎

boolean Exists ( )⚓︎

Returns true, if this entity still exists.

Get·Boss·ID ()⚓︎

BossId GetBossID ( )⚓︎

If the entity is a boss, it returns its specific boss id. If it isnt a boss it will return 0.

Get·Color ()⚓︎

const Color GetColor ( )⚓︎

Returns the Color object assosiated to this entity.

Get·Data ()⚓︎

table GetData ( )⚓︎

Returns a table that contains all data assosiated with the entity. This can be used to add custom data as well.

Notes

Data associated with an entity does only persists in between rooms, when the entity is a player, familiar or the entity has the "EntityFlag.FLAG_PERSISTENT" Flag active. Data does not persists in between exiting the game to a menu, or when restarting/finishing a run.

Example Code

This code adds custom data to an entity or prints it in the console if it exists.

if type(entity:GetData()["MyValue"]) == type(nil) then -- checks, if the Data does exist already
    entity:GetData()["MyValue"] = "Cool" -- assign a value to the data
else 
    print(entity:GetData()["MyValue"])  -- this will print "Cool" in the console
end

Get·Drop·RNG ()⚓︎

RNG GetDropRNG ( )⚓︎

Returns the assigned RNG object for the entity. This RNG is used to determine the items that are dropped on the entities death.

Get·Entity·Flags ()⚓︎

int GetEntityFlags ( )⚓︎

Get the EntityFlagsof the entity. This will be a number which acts like a bitmask.

Example Code

This code prints something in the console, if the entity has a specific EntityFlags.

if entity:GetEntityFlags() & EntityFlag.FLAG_CONFUSION == EntityFlag.FLAG_CONFUSION then
    print("This entity is confused!")
end

Get·Last·Child ()⚓︎

Entity GetLastChild ( )⚓︎

Returns the last entity spawned by this entity.

Return behavior

If no child is found, this function returns nil.

Get·Last·Parent ()⚓︎

Entity GetLastParent ( )⚓︎

Returns the last parent of this entity.

Return behavior

If no parent is found, this function returns nil.

Get·Sprite ()⚓︎

Sprite GetSprite ( )⚓︎

Return the sprite object of the entity.

Has·Common·Parent·With·Entity ()⚓︎

boolean HasCommonParentWithEntity ( Entity Other )⚓︎

Has·Entity·Flags ()⚓︎

boolean HasEntityFlags ( int Flags )⚓︎

Returns true, if the entity has all named EntityFlags set.

Example Code

This code prints something in the console, if the entity has a specific EntityFlags.

if entity:HasEntityFlags(EntityFlag.FLAG_CONFUSION) then
    print("This entity is confused!")
end

Has·Full·Health ()⚓︎

boolean HasFullHealth ( )⚓︎

Has·Mortal·Damage ()⚓︎

boolean HasMortalDamage ( )⚓︎

Notes

The game adds taken damage to a damage buffer, which gets applied in the next frame. HasMortalDamage() returns true if the buffered damage is enough to kill the entity. HasMortalDamage() will be updated additionally after TakeDamage() is called.

Is·Active·Enemy ()⚓︎

boolean IsActiveEnemy ( boolean includeDead )⚓︎

return true for non background NPCs (ex: every enemy except fire and shopkeepers)

Is·Boss ()⚓︎

boolean IsBoss ( )⚓︎

bosses display health bar

Is·Dead ()⚓︎

boolean IsDead ( )⚓︎

Is·Enemy ()⚓︎

boolean IsEnemy ( )⚓︎

return true for NPCs that are not controlled by the player

Is·Flying ()⚓︎

boolean IsFlying ( )⚓︎

Is·Frame ()⚓︎

boolean IsFrame ( int Frame, int Offset )⚓︎

true every X frames

Is·Invincible ()⚓︎

boolean IsInvincible ( )⚓︎

Is·Visible ()⚓︎

boolean IsVisible ( )⚓︎

Is·Vulnerable·Enemy ()⚓︎

boolean IsVulnerableEnemy ( )⚓︎

return true for enemies that can be damaged

Kill ()⚓︎

void Kill ( )⚓︎

Kills the entity and makes a blood splat or gibs.

Multiply·Friction ()⚓︎

void MultiplyFriction ( float Value )⚓︎

Post·Render ()⚓︎

void PostRender ( )⚓︎

Remove ()⚓︎

void Remove ( )⚓︎

Remove the entity from the game instantly, without doing any additional effects/animations.

Remove·Status·Effects ()⚓︎

void RemoveStatusEffects ( )⚓︎

Removes all Status Effects from the entity.

Render ()⚓︎

void Render ( Vector Offset )⚓︎

Render the current sprite of the Entity at the current entity position + offset.

Render·Shadow·Layer ()⚓︎

boolean RenderShadowLayer ( Vector Offset )⚓︎

Render the shadow / shadow layer again.

Set·Color ()⚓︎

Set the colormask for the entity. This can be used to tint the sprites in different colors.

Example Code

This code changes the color of the sprite to a fully white sprite for 15 frames.

entity:SetColor(Color(1, 1, 1, 1, 255, 255, 255), 15, 1, false, false)

Set·Size ()⚓︎

void SetSize ( float Size, Vector SizeMulti, int NumGridCollisionPoints )⚓︎

Set the size ofthe entity.

Set·Sprite·Frame ()⚓︎

void SetSpriteFrame ( string AnimationName, int FrameNum )⚓︎

Set·Sprite·Overlay·Frame ()⚓︎

void SetSpriteOverlayFrame ( string AnimationName, int FrameNum )⚓︎

Take·Damage ()⚓︎

boolean TakeDamage ( float Damage, int Flags, EntityRef Source, int DamageCountdown )⚓︎

Notes

The game adds taken damage to a damage buffer, which gets applied in the next frame. Therefore, TakeDamage() will not decremented the entities HP immediately upon calling the function. Rather, it is only updated on the frame afterwards.