Skip to main content

Sound

Functions

getMusicForStage

getMusicForStage(stage?, stageType?): Music

Helper function to get the corresponding music value for a stage and stage type combination.

Parameters

NameTypeDescription
stage?LevelStageOptional. The stage to get the music for. If not specified, the current stage will be used.
stageType?StageTypeOptional. The stage type to get the music for. If not specified, the current stage type will be used.

Returns

Music

Defined in

packages/isaacscript-common/src/functions/sound.ts:21


stopAllSoundEffects

stopAllSoundEffects(soundEffectCustom?): void

Helper function to manually stop every vanilla sound effect. If you also want to stop custom sound effects in addition to vanilla ones, then pass the SoundEffectCustom enum for your mod.

Parameters

NameTypeDescription
soundEffectCustom?TranspiledEnumOptional. The enum that represents all of the custom sound effects for your mod.

Returns

void

Defined in

packages/isaacscript-common/src/functions/sound.ts:46