Class "GridEntity"

Info

You can get this class by using the following function:

• Isaac.GridSpawn()
• Room.GetGridEntity()
• Room.GetGridEntityFromPos()

Example Code

Game():GetRoom():GetGridEntity(25)

Class Diagram

Content Overview

Return value	Function
boolean	Destroy ( boolean Immediate )Copy to clipboard
boolean	DestroyWithSource ( boolean Immediate, EntityRef Source )Copy to clipboard
int	GetGridIndex ( )Copy to clipboard
RNG	GetRNG ( )Copy to clipboard
GridEntityDesc	GetSaveState ( )Copy to clipboard
Sprite	GetSprite ( )Copy to clipboard
GridEntityType	GetType ( )Copy to clipboard
int	GetVariant ( )Copy to clipboard
boolean	Hurt ( int Damage )Copy to clipboard
boolean	HurtWithSource ( int Damage, EntityRef Source )Copy to clipboard
void	Init ( int Seed )Copy to clipboard
void	PostInit ( )Copy to clipboard
void	Render ( Vector Offset )Copy to clipboard
void	SetType ( GridEntityType Type )Copy to clipboard
void	SetVariant ( int Variant )Copy to clipboard
GridEntityDoor	ToDoor ( )Copy to clipboard
GridEntityPit	ToPit ( )Copy to clipboard
GridEntityPoop	ToPoop ( )Copy to clipboard
GridEntityPressurePlate	ToPressurePlate ( )Copy to clipboard
GridEntityRock	ToRock ( )Copy to clipboard
GridEntitySpikes	ToSpikes ( )Copy to clipboard
GridEntityTNT	ToTNT ( )Copy to clipboard
void	Update ( )Copy to clipboard
GridCollisionClass	CollisionClassCopy to clipboard
GridEntityDesc	DescCopy to clipboard
const Vector	PositionCopy to clipboard
int	StateCopy to clipboard
int	VarDataCopy to clipboard

---

Functions

Destroy ()

boolean Destroy ( boolean Immediate )Copy to clipboard

---

DestroyWithSource ()

boolean DestroyWithSource ( boolean Immediate, EntityRef Source )Copy to clipboard

---

GetGridIndex ()

int GetGridIndex ( )Copy to clipboard

---

GetRNG ()

RNG GetRNG ( )Copy to clipboard

Warning

This RNG is initialized with the same seed for all grid entities in the whole run. Instead, it's advised to create a custom data structure or use either the SpawnSeed or VariableSeed fields from the GridEntityDesc object.

---

GetSaveState ()

GridEntityDesc GetSaveState ( )Copy to clipboard

Info

Both the Desc property and the GetSaveState() method return the exact same GridEntityDesc object. The game devs advise to use GetSaveState() instead of Desc.

---

GetSprite ()

Sprite GetSprite ( )Copy to clipboard

---

GetType ()

GridEntityType GetType ( )Copy to clipboard

---

GetVariant ()

int GetVariant ( )Copy to clipboard

---

Hurt ()

boolean Hurt ( int Damage )Copy to clipboard

---

HurtWithSource ()

boolean HurtWithSource ( int Damage, EntityRef Source )Copy to clipboard

---

Init ()

void Init ( int Seed )Copy to clipboard

---

PostInit ()

void PostInit ( )Copy to clipboard

---

Render ()

void Render ( Vector Offset )Copy to clipboard

---

SetType ()

void SetType ( GridEntityType Type )Copy to clipboard

---

SetVariant ()

void SetVariant ( int Variant )Copy to clipboard

---

ToDoor ()

GridEntityDoor ToDoor ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToPit ()

GridEntityPit ToPit ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToPoop ()

GridEntityPoop ToPoop ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToPressurePlate ()

GridEntityPressurePlate ToPressurePlate ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToRock ()

GridEntityRock ToRock ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToSpikes ()

GridEntitySpikes ToSpikes ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

ToTNT ()

GridEntityTNT ToTNT ( )Copy to clipboard

Return behavior

If the conversion is not successful, this function returns nil.

---

Update ()

void Update ( )Copy to clipboard

---

Variables

CollisionClass

GridCollisionClass CollisionClassCopy to clipboard

---

Desc

GridEntityDesc DescCopy to clipboard

Info

Both the Desc property and the GetSaveState() method return the exact same GridEntityDesc object. The game devs advise to use GetSaveState() instead of Desc.

---

Position

const Vector PositionCopy to clipboard

Returns the position of the grid cell's center point

---

State

int StateCopy to clipboard

Used for various different usecases.

Example States

Rocks with state = 2 are destroyed rocks (The rubble is the rock basically)

---

VarData

int VarDataCopy to clipboard

A Variable that stores some entity-specific data. The content can have completely different effects for different GridEntities.

Example Code

This code spawns a functioning Void Portal into the center of the room. This will teleport you to the floor "The Void" and will have the same appearance as the vanilla portal:

-- From: https://github.com/IsaacScript/isaac-typescript-definitions/blob/main/typings/unofficial/enumsGridEntityVariants.d.ts
local TrapdoorVariant = {
  NORMAL = 0,
  VOID_PORTAL = 1,
}

local game = Game();
local room = game:GetRoom()
local centerPos = room:GetCenterPos()

-- By default, this will spawn a normal trapdoor, even though we specify the Void Portal variant
local voidPortal = Isaac.GridSpawn(GridEntityType.GRID_TRAPDOOR, TrapdoorVariant.VOID_PORTAL, centerPos, true)

-- Set the destination to The Void and apply the pulse effect shader
voidPortal.VarData = 1

-- Replace the spritesheet to make it look like a Void Portal
local sprite = portalEntity:GetSprite()
sprite:Load("gfx/grid/voidtrapdoor.anm2", true)

---

---

Last update: March 20, 2025