Interface IAudioEvents

Hierarchy

IAudioEvents

Index

Methods

init playUiSoundEffect? queueGameSoundEffect?

Methods

init

init(): any
Returns any
- Defined in src/game/audio/Audio.ts:73

`Optional` playUiSoundEffect

playUiSoundEffect(type: SfxType): undefined | boolean | SfxType
Called when a ui sound effect is played

Returns
False to cancel the sound effect, a sound effect to play instead of the given one, or undefined to use the default logic
Parameters
- type: SfxType
  
  The sound effect type
Returns undefined | boolean | SfxType
- Defined in src/game/audio/Audio.ts:80

`Optional` queueGameSoundEffect

queueGameSoundEffect(type: SfxType, position: IVector4): undefined | boolean | SfxType
Called when a game sound effect is queued

Returns
False to cancel the sound effect, a sound effect to play instead of the given one, or undefined to use the default logic
Parameters
- type: SfxType
  
  The sound effect type
- position: IVector4
  
  The position of the sound effect
Returns undefined | boolean | SfxType
- Defined in src/game/audio/Audio.ts:88

Generated using TypeDoc