Doors

Overview

Return Value

Function

void

integer

{x:integer, y:integer}?

boolean

void

Functions

CloseAllDoors()

void CloseAllDoors(boolean playAnim)

Helper funciton to close all doors in the current room.

CloseDoorFast()

Helper function to open a door instantly without playing its open animation.

DoorSlotsToDoorSlotBitMask()

Helper function to convert the provided door slots into a door slot bitmask.

DoorSlotToDirection()

Helper function to get the direction corresponding to a given door slot.

DoorSlotToDoorSlotFlag()

Helper function to get a door slot flag from a door slot.

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()

Helper function to get the angel room door in the current room. If there isn't any, returns nil.

GetBlueWombDoor()

Helper function to get the door that leads to the blue womb entrance in the current room.

GetDevilRoomDoor()

Helper function to get the devil room door in the current room. If there isn't any, returns nil.

GetDoorEnterPosition()

Helper function to get the position that a player will enter a room at corresponding to a door.

GetDoors()

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()

Helper function to get the position that a player will enter a room at corresponding to a door slot.

GetDoorSlotEnterPositionOffset()

Helper function to get the offset from a door position that a player will enter a room at.

GetDoorSlotsForRoomShape()

Helper function to get all the possible door slots in a room shape.

GetDoorSlotsFromDoorSlotBitMask()

Helper function to get the door slots corresponding to a door slot bit mask.

GetDoorsToRoomIndex()

Helper function to return all doors in the current room that lead to a given room index.

GetRoomShapeDoorSlot()

Helper function to get the corresponding door slot for a given room shape and grid coordinates.

GetRoomShapeDoorSlotCoordinates()

Helper function to get the grid coordinates for a specific room shape and door slot combination.

GetSecretExitDoor()

Helper function to get the door that leads to a repentance secret exit in the current room.

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()

Helper function to see if a door leads to an angel deal room.

IsBlueWombDoor()

Helper function to see if a door is the blue womb entrance door that appears after defeating Mom's Heart/It Lives.

IsDevilRoomDoor()

Helper function to see if a door leads to an devil deal room.

IsDoorSlotInRoomShape()

Helper function to check if a given door slot can be present in a given room shape.

IsDoorToDownpour()

Helper function to see if a door leads to the secret exit to Downpour.

IsDoorToMausoleum()

Helper function to see if a door leads to the secret exit to Mausoleum.

IsDoorToMausoleumAscent()

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()

Helper function to see if a door leads to the secret exit to Mines.

IsDoorToMomsHeart()

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()

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()

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()

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()

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()

Helper function to open a door instantly without playing its open animation.

RemoveAllDoorsOfType()

Helper function to remove all doors of the given room types.

RemoveDoor()

Helper function to remove a single door

RemoveDoors()

Helper function to remove all the given doors

PreviousDirection NextEffects

Last updated 2 years ago

Doors

Overview

Return Value

Function

void

(boolean playAnim)

void

( door)

integer

( ...)

( doorSlot)

integer

( doorSlot)

()

( door)

[]

( ...)

( doorSlot)

(any doorSlot)

[]

( roomShape)

[]

(integer doorSlotBitMask)

[]

(integer ...)

( roomShape, integer x, integer y)

{x:integer, y:integer}?

( roomShape, doorSlot)

()

[]

()

boolean

()

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( doorSlot, roomShape)

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( door)

boolean

( door)

void

( door)

void

(boolean playAnim)

void

( door)

void

( ...)

void

( door)

void

([] doors)

Functions

CloseAllDoors()

void CloseAllDoors(boolean playAnim)

Helper funciton to close all doors in the current room.

CloseDoorFast()

void CloseDoorFast( door)

Helper function to open a door instantly without playing its open animation.

DoorSlotsToDoorSlotBitMask()

integer DoorSlotsToDoorSlotBitMask( ...)

Helper function to convert the provided door slots into a door slot bitmask.

DoorSlotToDirection()

DoorSlotToDirection( doorSlot)

Helper function to get the direction corresponding to a given door slot.

DoorSlotToDoorSlotFlag()

integer DoorSlotToDoorSlotFlag( doorSlot)

Helper function to get a door slot flag from a door slot.

GetAngelOrDevilRoomDoor()

? 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()

? GetAngelRoomDoor()

Helper function to get the angel room door in the current room. If there isn't any, returns nil.

GetBlueWombDoor()

? GetBlueWombDoor()

Helper function to get the door that leads to the blue womb entrance in the current room.

GetDevilRoomDoor()

? GetDevilRoomDoor()

Helper function to get the devil room door in the current room. If there isn't any, returns nil.

GetDoorEnterPosition()

GetDoorEnterPosition( door)

Helper function to get the position that a player will enter a room at corresponding to a door.

GetDoors()

[] GetDoors( ...)

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()

GetDoorSlotEnterPosition( doorSlot)

Helper function to get the position that a player will enter a room at corresponding to a door slot.

GetDoorSlotEnterPositionOffset()

GetDoorSlotEnterPositionOffset(any doorSlot)

Helper function to get the offset from a door position that a player will enter a room at.

GetDoorSlotsForRoomShape()

[] GetDoorSlotsForRoomShape( roomShape)

Helper function to get all the possible door slots in a room shape.

GetDoorSlotsFromDoorSlotBitMask()

[] GetDoorSlotsFromDoorSlotBitMask(integer doorSlotBitMask)

Helper function to get the door slots corresponding to a door slot bit mask.

GetDoorsToRoomIndex()

[] GetDoorsToRoomIndex(integer ...)

Helper function to return all doors in the current room that lead to a given room index.

GetRoomShapeDoorSlot()

? GetRoomShapeDoorSlot( 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, doorSlot)

Helper function to get the grid coordinates for a specific room shape and door slot combination.

GetSecretExitDoor()

? GetSecretExitDoor()

Helper function to get the door that leads to a repentance secret exit in the current room.

GetUnusedDoorSlots()

[] 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( door)

Helper function to see if a door leads to an angel deal room.

IsBlueWombDoor()

boolean IsBlueWombDoor( 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( door)

Helper function to see if a door leads to an devil deal room.

IsDoorSlotInRoomShape()

boolean IsDoorSlotInRoomShape(doorSlot, roomShape)

Helper function to check if a given door slot can be present in a given room shape.

IsDoorToDownpour()

boolean IsDoorToDownpour( door)

Helper function to see if a door leads to the secret exit to Downpour.

IsDoorToMausoleum()

boolean IsDoorToMausoleum( door)

Helper function to see if a door leads to the secret exit to Mausoleum.

IsDoorToMausoleumAscent()

boolean IsDoorToMausoleumAscent( 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( door)

Helper function to see if a door leads to the secret exit to Mines.

IsDoorToMomsHeart()

boolean IsDoorToMomsHeart( 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( 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( 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( 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( 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( door)

Helper function to open a door instantly without playing its open animation.

RemoveAllDoorsOfType()

void RemoveAllDoorsOfType( ...)

Helper function to remove all doors of the given room types.

RemoveDoor()

void RemoveDoor( door)

Helper function to remove a single door

RemoveDoors()

void RemoveDoors([] doors)

Helper function to remove all the given doors

PreviousDirection NextEffects

Last updated 2 years ago