Skip to main content

Disable All Sound

Hierarchy

  • Feature

    DisableAllSound

Methods

enableAllSound

enableAllSound(key): void

Helper function to stop muting all sound effects and music.

Use this function to set things back to normal after having used disableAllSounds.

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

Parameters

NameTypeDescription
keystringThe name of the mod feature that is requesting the enable/disable. For example, if this was part of the code for a custom enemy called "Super Gaper", then you could use a key of "SuperGaper". The name is necessary so that multiple mod features can work in tandem.

Returns

void

Defined in

packages/isaacscript-common/src/classes/features/other/DisableAllSound.ts:51


disableAllSound

disableAllSound(key): void

Helper function to disable all sound effects and music (by constantly musting them).

Use the enableAllSounds helper function to set things back to normal.

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

Parameters

NameTypeDescription
keystringThe name of the mod feature that is requesting the enable/disable. For example, if this was part of the code for a custom enemy called "Super Gaper", then you could use a key of "SuperGaper". The name is necessary so that multiple mod features can work in tandem.

Returns

void

Defined in

packages/isaacscript-common/src/classes/features/other/DisableAllSound.ts:79