Custom Stages
Classes
Section titled “Classes”CustomStages
Section titled “CustomStages”Defined in: packages/isaacscript-common/src/classes/features/other/CustomStages.ts:85
Extends
Section titled “Extends”Feature
Methods
Section titled “Methods”setCustomStage()
Section titled “setCustomStage()”setCustomStage(
name,firstFloor?,streakText?,verbose?):void
Defined in: packages/isaacscript-common/src/classes/features/other/CustomStages.ts:494
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.
Parameters
Section titled “Parameters”string
The name of the custom stage, corresponding to what is in the “tsconfig.json” file.
firstFloor?
Section titled “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?
Section titled “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?
Section titled “verbose?”boolean = false
Optional. Whether to log additional information about the rooms that are chosen. Default is false.
Returns
Section titled “Returns”void
disableCustomStage()
Section titled “disableCustomStage()”disableCustomStage():
void
Defined in: packages/isaacscript-common/src/classes/features/other/CustomStages.ts:605
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.
Returns
Section titled “Returns”void