📚
Library of Isaac
  • Library of Isaac
  • Get Started
  • F.A.Q.
  • Custom Enums
    • AmbushType
    • AngelVariant
    • BabyLongLegsVariant
    • BabyVariant
    • BeastVariant
    • BegottenVariant
    • BigBonyVariant
    • BigHornVariant
    • BloodClotSubType
    • BloodExplosionSubType
    • BloodPuppyVariant
    • BlueFlySubType
    • BoilVariant
    • BonyVariant
    • BoomFlyVariant
    • BossID
    • CallbackOptionalArgType
    • CallbackReturnMode
    • CanaryVariant
    • Charger2Variant
    • ChargerSubType
    • ChargerVariant
    • ChimeraVariant
    • ChubVariant
    • ClottyVariant
    • ClutchVariant
    • ConjoinedFattyVariant
    • ConstantStoneShooterSubType
    • ConstantStoneShooterVariant
    • ConversionHeartSubType
    • CopyableIsaacAPIClassType
    • CrawlSpaceVariant
    • CrazyLongLegsVariant
    • CultistVariant
    • CustomCallback
    • CustomReviveType
    • DaddyLongLegsVariant
    • DannyVariant
    • DarkEsauVariant
    • DeathsHeadVariant
    • DeathVariant
    • DebugMode
    • DiceFloorSubType
    • Dimension
    • DingleVariant
    • DipFamiliarSubType
    • DipVariant
    • DogmaVariant
    • DopleVariant
    • DukeVariant
    • DumpVariant
    • EnvyVariant
    • EvisVariant
    • ExorcistVariant
    • EyeVariant
    • FacelessVariant
    • FallenVariant
    • FattyVariant
    • FireplaceVariant
    • FistulaVariant
    • FlyBombVariant
    • Gaper2Variant
    • GaperVariant
    • GeminiVariant
    • GenericPropVariant
    • GibSubType
    • GlobinVariant
    • GluttonyVariant
    • GoatVariant
    • GreedVariant
    • GridEntityXMLType
    • GrimaceVariant
    • GrubVariant
    • GurgleVariant
    • GurglingVariant
    • GusherVariant
    • GutsVariant
    • GuttedFattyVariant
    • GyroVariant
    • HauntVariant
    • HealthType
    • HeartVariant
    • HeavenLightDoorSubType
    • HiveVariant
    • HomunculusVariant
    • HopperVariant
    • HostVariant
    • InventoryType
    • IsaacVariant
    • ItemConfigTag
    • KnifeVariant
    • KnightVariant
    • LambVariant
    • LarryJrVariant
    • LeaperVariant
    • LeechVariant
    • LeperVariant
    • LittleHornVariant
    • LockState
    • LokiVariant
    • LustVariant
    • MamaGurdyVariant
    • MaskVariant
    • MawVariant
    • MegaSatanVariant
    • MembrainVariant
    • MoleVariant
    • MomsHeartVariant
    • MomVariant
    • Monstro2Variant
    • MotherSubType
    • MotherVariant
    • MoveableTNTVariant
    • MrMawVariant
    • MrMineVariant
    • MulliganVariant
    • NeedleVariant
    • NerveEndingVariant
    • ParaBiteVariant
    • PeeperFattyVariant
    • PeepVariant
    • PickupNullSubType
    • PillEffectType
    • PinVariant
    • PitfallVariant
    • PitState
    • PitVariant
    • PokyVariant
    • PoltyVariant
    • PolycephalusVariant
    • PoofSubType
    • PoopEntityVariant
    • PoopGridEntityVariant
    • PoopState
    • PooterVariant
    • PortalVariant
    • PressurePlateVariant
    • PreyVariant
    • PrideVariant
    • ProjectilesMode
    • PurgatorySubType
    • RageCreepVariant
    • RaglichVariant
    • RaglingVariant
    • RagManVariant
    • RagMegaVariant
    • RevenantVariant
    • RockSpiderVariant
    • RockState
    • RockVariant
    • RotgutVariant
    • RoundWormVariant
    • SatanVariant
    • ScourgeVariant
    • SerializationBrand
    • SerializationType
    • ShockwaveSoundMode
    • ShopKeeperVariant
    • SingeVariant
    • SirenVariant
    • SkinnyVariant
    • SlothVariant
    • SlotVariant
    • SpiderWebState
    • SpittyVariant
    • SquirtVariant
    • StageID
    • StatueVariant
    • StoneyVariant
    • SubHorfVariant
    • SuckerVariant
    • SwingerVariant
    • TallLadderSubType
    • TNTState
    • TrapdoorVariant
    • TumorVariant
    • UltraCoinVariant
    • UltraGreedVariant
    • VariablePersistenceMode
    • VisageVariant
    • VisFattyVariant
    • VisVariant
    • WalkingBoilVariant
    • WallCreepVariant
    • WarVariant
    • WhipperVariant
    • WidowVariant
    • WrathVariant
  • CustomCallback
  • Modules
    • Ambush
    • Benchmark
    • BitSet128
    • Bombs
    • Bosses
    • Charge
    • Collectibles
    • Color
    • CustomItemPools
    • Debug
    • Dimensions
    • Direction
    • Doors
    • Effects
    • Entities
    • EntitySpecific
    • Familiars
    • GridEntities
    • GridIndexes
    • GridSpecific
    • Input
    • IsaacAPIClass
    • ItemPool
    • JSON
    • Log
    • Pause
    • Pickups
    • PickupSpecific
    • Pills
    • Players
    • Random
    • RNG
    • Rooms
    • RoomSpecific
    • Run
    • SaveManager
    • Serialize
    • ShockWaves
    • Sprites
    • Stage
    • Trinkets
    • UI
    • Utils
      • DeepCopy
      • Easings
      • Flags
      • Functions
      • Math
      • String
      • Tables
    • Vector
Powered by GitBook
On this page
  • Overview
  • Functions
  • ConvertXMLGridEntityType()
  • GetCollidingEntitiesWithGridEntity()
  • GetGridEntities()
  • GetGridEntitiesMap()
  • GetSurroundingGridEntities()
  • GetTopLeftWall()
  • GetTopLeftWallGridIndex()
  • IsGridEntityBreakableByExplosion()
  • IsGridEntityBroken()
  • RemoveGridEntities()
  • RemoveGridEntity()
  • SpawnGigaPoop()
  • SpawnGridEntity()
  • SpawnVoidPortal()
  1. Modules

GridEntities

Overview

Return Value
Function

{type : GridEntityType, variant : integer}

integer

boolean

boolean

void

void

boolean

Functions

ConvertXMLGridEntityType()

Helper function to convert the grid entity type found in a room XML file to the corresponding grid entity type and variant normally used by the game. For example, a rock is represented as 1000.0 in a room XML file, but GridEntityType.GRID_ROCK is equal to 2.

GetCollidingEntitiesWithGridEntity()

Returns all the entities that are colliding with a given grid entity. Note that this function won't work in the POST_NEW_ROOM callback, since entities don't have collision yet.

GetGridEntities()

Returns a list with all grid entities in the room.

GetGridEntitiesMap()

Returns a map with all grid entities in the room indexed by their grid index.

GetSurroundingGridEntities()

Helper function to get all grid entities around a grid index, not including itself.

GetTopLeftWall()

Helper function to get the top left wall grid entity.

GetTopLeftWallGridIndex()

integer GetTopLeftWallGridIndex()

Helper function to get the grid index of the top left wall.

IsGridEntityBreakableByExplosion()

Helper function to check if a GridEntity is able to be broken with an explosion.

IsGridEntityBroken()

Helper function to see if the given GridEntity is in its respective broken state. Note that GridEntityType.GRID_LOCK will turn to being broken before the actual collision is turned off.

RemoveGridEntities()

Helper function to remove all grid entities from a given list.

RemoveGridEntity()

Helper function to remove a grid entity by providing the GridEntity or the grid index. If removing a Devil or Angel Statue it'll also remove the associated effect.

SpawnGigaPoop()

Helper function to spawn a giant poop. Will return true if the poop has successfully spawned.

SpawnGridEntity()

Helper function to spawn a grid entity. Use this instead of Isaac.GridSpawn as it handles: - Walls and pits collision - Removing existing grid entities - Allows you to use the grid index

SpawnVoidPortal()

Helper function to spawn a void portal. This is more complicated than just spawning a trapdoor with the appropriate variant, as it won't have the correct graphics and it won't lead to The Void.

PreviousFamiliarsNextGridIndexes

Last updated 2 years ago

( gridEntityXMLType, integer gridEntityXMLVariant)

[]

( gridEntity)

[]

( ...)

table<integer, >

( ...)

[]

( gridIndex)

()

()

( gridEntity)

( gridEntity)

([] gridEntities, boolean updateRoom)

(`

(`

?

( gridEntityType, integer gridEntityVariant, `

?

(`

{type : GridEntityType, variant : integer} ConvertXMLGridEntityType( gridEntityXMLType, integer gridEntityXMLVariant)

[] GetCollidingEntitiesWithGridEntity( gridEntity)

[] GetGridEntities( ...)

table<integer, > GetGridEntitiesMap( ...)

[] GetSurroundingGridEntities( gridIndex)

GetTopLeftWall()

boolean IsGridEntityBreakableByExplosion( gridEntity)

boolean IsGridEntityBroken( gridEntity)

void RemoveGridEntities([] gridEntities, boolean updateRoom)

void RemoveGridEntity( | integer gridEntityOrGridIndex, boolean updateRoom)

boolean SpawnGigaPoop( | integer topLeftGridIndexOrPosition, boolean? force)

? SpawnGridEntity(gridEntityType, integer gridEntityVariant, | integer gridIndexOrPosition, boolean? force)

? SpawnVoidPortal( | integer gridIndexOrPosition, boolean? force)

GridEntityXMLType
Entity
GridEntity
GridEntity
GridEntityType
GridEntity
GridEntityType
GridEntity
GridEntity
GridEntity
GridEntity
GridEntity
GridEntity
GridEntity
Vector
GridEntity
GridEntityType
Vector
GridEntity
Vector
Entity
GridEntity
GridEntity
GridEntity
GridEntity
GridEntity
GridEntity
GridEntityXMLType
ConvertXMLGridEntityType
GridEntity
GetCollidingEntitiesWithGridEntity
GridEntityType
GetGridEntities
GridEntityType
GetGridEntitiesMap
GridEntity
GetSurroundingGridEntities
GetTopLeftWall
GetTopLeftWallGridIndex
GridEntity
IsGridEntityBreakableByExplosion
GridEntity
IsGridEntityBroken
GridEntity
RemoveGridEntities
GridEntity
RemoveGridEntity
Vector
SpawnGigaPoop
GridEntityType
Vector
SpawnGridEntity
Vector
SpawnVoidPortal