isaacscript-common
Version:
Helper functions and features for IsaacScript mods.
25 lines • 1.24 kB
TypeScript
import { Direction, RoomTransitionAnim } from "isaac-typescript-definitions";
/**
* 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.
*/
export declare function reloadRoom(): 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.
*
* @param roomGridIndex The room grid index of the destination room.
* @param direction Optional. Default is `Direction.NO_DIRECTION`.
* @param roomTransitionAnim Optional. Default is `RoomTransitionAnim.TELEPORT`.
*/
export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim): void;
//# sourceMappingURL=roomTransition.d.ts.map