Stage History
Hierarchy
-
Feature↳
StageHistory
Methods
getNextStageTypeWithHistory
▸ getNextStageTypeWithHistory(upwards?): StageType
Helper function to get the stage type that a trapdoor or heaven door would take the player to, based on the current stage, room, and game state flags.
This function accounts for the previous floors that a player has visited thus far on the run so
that the next stage type can be properly calculated on The Ascent (which makes it unlike the
getNextStageType function).
In order to use this function, you must upgrade your mod with ISCFeature.STAGE_HISTORY.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
upwards | boolean | false | Whether the player should go up to Cathedral in the case of being on Womb 2. Default is false. |
Returns
StageType
Defined in
packages/isaacscript-common/src/classes/features/other/StageHistory.ts:60
getNextStageWithHistory
▸ getNextStageWithHistory(): LevelStage
Helper function to get the stage that a trapdoor or heaven door would take the player to, based on the current stage, room, and game state flags.
This function accounts for the previous floors that a player has visited thus far on the run so
that the next stage can be properly calculated on The Ascent (which makes it unlike the
getNextStage function).
In order to use this function, you must upgrade your mod with ISCFeature.STAGE_HISTORY.
Returns
LevelStage
Defined in
packages/isaacscript-common/src/classes/features/other/StageHistory.ts:168
getStageHistory
▸ getStageHistory(): readonly StageHistoryEntry[]
Helper function to get all of the stages that a player has visited thus far on this run.
In order to use this function, you must upgrade your mod with ISCFeature.STAGE_HISTORY.
Returns
readonly StageHistoryEntry[]
Defined in
packages/isaacscript-common/src/classes/features/other/StageHistory.ts:302
hasVisitedStage
▸ hasVisitedStage(stage, stageType?): boolean
Helper function to check if a player has previous visited a particular stage (or stage + stage type combination) on this run.
In order to use this function, you must upgrade your mod with ISCFeature.STAGE_HISTORY.
Parameters
| Name | Type | Description |
|---|---|---|
stage | LevelStage | The stage to check for. |
stageType? | StageType | Optional. If provided, will check for a specific stage and stage type combination. |
Returns
boolean
Defined in
packages/isaacscript-common/src/classes/features/other/StageHistory.ts:317