Doors
Overview
void
CloseAllDoors(boolean
playAnim)
void
CloseDoorFast(GridEntityDoor
door)
integer
DoorSlotToDirection(DoorSlot
doorSlot)
integer
DoorSlotToDoorSlotFlag(DoorSlot
doorSlot)
GetDoorSlotEnterPosition(DoorSlot
doorSlot)
GetDoorSlotEnterPositionOffset(any
doorSlot)
DoorSlot[]
GetDoorSlotsForRoomShape(RoomShape
roomShape)
DoorSlot[]
GetDoorSlotsFromDoorSlotBitMask(integer
doorSlotBitMask)
GetDoorsToRoomIndex(integer
...)
GetRoomShapeDoorSlot(RoomShape
roomShape, integer
x, integer
y)
{x:integer, y:integer}?
GetRoomShapeDoorSlotCoordinates(RoomShape
roomShape, DoorSlot
doorSlot)
boolean
boolean
boolean
IsBlueWombDoor(GridEntityDoor
door)
boolean
boolean
IsDoorSlotInRoomShape(DoorSlot
doorSlot, RoomShape
roomShape)
boolean
boolean
boolean
boolean
IsDoorToMines(GridEntityDoor
door)
boolean
boolean
boolean
boolean
void
LockDoor(GridEntityDoor
door)
void
OpenAllDoors(boolean
playAnim)
void
OpenDoorFast(GridEntityDoor
door)
void
void
RemoveDoor(GridEntityDoor
door)
void
RemoveDoors(GridEntityDoor
[]
doors)
Functions
CloseAllDoors()
void CloseAllDoors(boolean playAnim)
Helper funciton to close all doors in the current room.
CloseDoorFast()
void CloseDoorFast(
GridEntityDoor
door)
Helper function to open a door instantly without playing its open animation.
DoorSlotsToDoorSlotBitMask()
integer DoorSlotsToDoorSlotBitMask(
DoorSlot
...)
Helper function to convert the provided door slots into a door slot bitmask.
DoorSlotToDirection()
Direction
DoorSlotToDirection(
DoorSlot
doorSlot)
Helper function to get the direction corresponding to a given door slot.
DoorSlotToDoorSlotFlag()
integer DoorSlotToDoorSlotFlag(
DoorSlot
doorSlot)
Helper function to get a door slot flag from a door slot.
GetAngelOrDevilRoomDoor()
GridEntityDoor
? GetAngelOrDevilRoomDoor()
Helper function to get an angel or devil room door in the current room. Note that if there are both an angel and devil room door it'll only return the one in the lowest door slot.
GetAngelRoomDoor()
GridEntityDoor
? GetAngelRoomDoor()
Helper function to get the angel room door in the current room. If there isn't any, returns nil.
GetBlueWombDoor()
GridEntityDoor
? GetBlueWombDoor()
Helper function to get the door that leads to the blue womb entrance in the current room.
GetDevilRoomDoor()
GridEntityDoor
? GetDevilRoomDoor()
Helper function to get the devil room door in the current room. If there isn't any, returns nil.
GetDoorEnterPosition()
Vector
GetDoorEnterPosition(
GridEntityDoor
door)
Helper function to get the position that a player will enter a room at corresponding to a door.
GetDoors()
GridEntityDoor
[] GetDoors(
RoomType
...)
Helper function to return all doors in the current room. You can optionally specify one or more room types to return only the doors that match the specified room types.
GetDoorSlotEnterPosition()
Vector
GetDoorSlotEnterPosition(
DoorSlot
doorSlot)
Helper function to get the position that a player will enter a room at corresponding to a door slot.
GetDoorSlotEnterPositionOffset()
Vector
GetDoorSlotEnterPositionOffset(any doorSlot)
Helper function to get the offset from a door position that a player will enter a room at.
GetDoorSlotsForRoomShape()
DoorSlot
[] GetDoorSlotsForRoomShape(
RoomShape
roomShape)
Helper function to get all the possible door slots in a room shape.
GetDoorSlotsFromDoorSlotBitMask()
DoorSlot
[] GetDoorSlotsFromDoorSlotBitMask(integer doorSlotBitMask)
Helper function to get the door slots corresponding to a door slot bit mask.
GetDoorsToRoomIndex()
GridEntityDoor
[] GetDoorsToRoomIndex(integer ...)
Helper function to return all doors in the current room that lead to a given room index.
GetRoomShapeDoorSlot()
DoorSlot
? GetRoomShapeDoorSlot(
RoomShape
roomShape, integer x, integer y)
Helper function to get the corresponding door slot for a given room shape and grid coordinates.
GetRoomShapeDoorSlotCoordinates()
{x:integer, y:integer}? GetRoomShapeDoorSlotCoordinates(
RoomShape
roomShape,
DoorSlot
doorSlot)
Helper function to get the grid coordinates for a specific room shape and door slot combination.
GetSecretExitDoor()
GridEntityDoor
? GetSecretExitDoor()
Helper function to get the door that leads to a repentance secret exit in the current room.
GetUnusedDoorSlots()
DoorSlot
[] GetUnusedDoorSlots()
Helper function to get all unused door slots in the current room. Useful to spawn custom doors.
HasUnusedDoorSlot()
boolean HasUnusedDoorSlot()
Helper function to check if the current room has any unused door slots.
IsAngelRoomDoor()
boolean IsAngelRoomDoor(
GridEntityDoor
door)
Helper function to see if a door leads to an angel deal room.
IsBlueWombDoor()
boolean IsBlueWombDoor(
GridEntityDoor
door)
Helper function to see if a door is the blue womb entrance door that appears after defeating Mom's Heart/It Lives.
IsDevilRoomDoor()
boolean IsDevilRoomDoor(
GridEntityDoor
door)
Helper function to see if a door leads to an devil deal room.
IsDoorSlotInRoomShape()
boolean IsDoorSlotInRoomShape(
DoorSlot
doorSlot,
RoomShape
roomShape)
Helper function to check if a given door slot can be present in a given room shape.
IsDoorToDownpour()
boolean IsDoorToDownpour(
GridEntityDoor
door)
Helper function to see if a door leads to the secret exit to Downpour.
IsDoorToMausoleum()
boolean IsDoorToMausoleum(
GridEntityDoor
door)
Helper function to see if a door leads to the secret exit to Mausoleum.
IsDoorToMausoleumAscent()
boolean IsDoorToMausoleumAscent(
GridEntityDoor
door)
Helper function to see if a door leads to the secret exit to the ascent version of Mausoleum, located in Depths 2 and requires The Polaroid or The Negative to open.
IsDoorToMines()
boolean IsDoorToMines(
GridEntityDoor
door)
Helper function to see if a door leads to the secret exit to Mines.
IsDoorToMomsHeart()
boolean IsDoorToMomsHeart(
GridEntityDoor
door)
Helper function to see if a door is the door that spawns after defeating Mom in Mausoleum II and requires both knife pieces to open.
IsHiddenSecretDoor()
boolean IsHiddenSecretDoor(
GridEntityDoor
door)
Helper function to check if a door is a hole in the wall that appears after bombing the entrance to a secret room but hasn't been revealed yet.
IsSecretExitDoor()
boolean IsSecretExitDoor(
GridEntityDoor
door)
Helper function to see if a door leads to any of the secret exit introduced in Repentance, that lead you to the Repentance floors.
IsSecretRoomDoor()
boolean IsSecretRoomDoor(
GridEntityDoor
door)
Helper function to check if a door is a hole in the wall that appears after bombing the entrance to a secret room. Note that the door still exists even if it hasn't been bombed yet.
LockDoor()
void LockDoor(
GridEntityDoor
door)
Helper function to reset an unlocked door back to its locked state.
OpenAllDoors()
void OpenAllDoors(boolean playAnim)
Helper funciton to open all doors in the current room
OpenDoorFast()
void OpenDoorFast(
GridEntityDoor
door)
Helper function to open a door instantly without playing its open animation.
RemoveAllDoorsOfType()
void RemoveAllDoorsOfType(
RoomType
...)
Helper function to remove all doors of the given room types.
RemoveDoor()
void RemoveDoor(
GridEntityDoor
door)
Helper function to remove a single door
RemoveDoors()
void RemoveDoors(
GridEntityDoor
[] doors)
Helper function to remove all the given doors
Last updated