Custom Stages

Hierarchy

▸ setCustomStage(name, firstFloor?, streakText?, verbose?): void

Helper function to warp to a custom stage/level.

Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for more details: https://isaacscript.github.io/main/custom-stages/

In order to use this function, you must upgrade your mod with ISCFeature.CUSTOM_STAGES.

Name	Type	Default value	Description
`name`	`string`	`undefined`	The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
`firstFloor`	`boolean`	`true`	Optional. Whether to go to the first floor or the second floor. For example, if you have a custom stage emulating Caves, then the first floor would be Caves 1, and the second floor would be Caves 2. Default is true.
`streakText`	`boolean`	`true`	Optional. Whether to show the streak text at the top of the screen that announces the name of the level. Default is true.
`verbose`	`boolean`	`false`	Optional. Whether to log additional information about the rooms that are chosen. Default is false.

void

▸ disableCustomStage(): void

Helper function to disable the custom stage. This is typically called before taking the player to a vanilla floor.

In order to use this function, you must upgrade your mod with ISCFeature.CUSTOM_STAGES.

void