Skip to main content

Room Transition

Functions

reloadRoom

reloadRoom(): void

Helper function to reload the current room using Game.StartRoomTransition.

This is useful for canceling the "goto" console command or to make the Level.SetStage method take effect.

Returns

void

Defined in

packages/isaacscript-common/src/functions/roomTransition.ts:16


teleport

teleport(roomGridIndex, direction?, roomTransitionAnim?): void

Helper function to change the current room. It can be used for both teleportation and "normal" room transitions, depending on what is passed for the direction and roomTransitionAnim arguments.

Use this function instead of invoking the Game.StartRoomTransition method directly so that:

  • you do not forget to set the Level.LeaveDoor field
  • to prevent crashing on invalid room grid indexes

Note that if the current floor has Curse of the Maze, it may redirect the intended teleport.

Parameters

NameTypeDefault valueDescription
roomGridIndexintundefinedThe room grid index of the destination room.
directionDirectionDirection.NO_DIRECTIONOptional. Default is Direction.NO_DIRECTION.
roomTransitionAnimRoomTransitionAnimRoomTransitionAnim.TELEPORTOptional. Default is RoomTransitionAnim.TELEPORT.

Returns

void

Defined in

packages/isaacscript-common/src/functions/roomTransition.ts:36