Class Sounds

Hierarchy (view full)

EventEmitter<SoundsEvents>
- Sounds

Index

Constructors

Properties

#lastState _events gp isMusicMuted isSFXMuted

Accessors

Methods

#muteMusic #muteSFX #saveToStorage #unmuteMusic #unmuteSFX mute muteMusic muteSFX off on once unmute unmuteMusic unmuteSFX

Constructors

constructor

new Sounds(gp): Sounds
Parameters
- gp: CoreSDK
Returns Sounds
Overrides EventEmitter.constructor
- Defined in core/sounds/Sounds.ts:22

Properties

`Private` #lastState

#lastState: {
isMusicMuted: boolean;
isSFXMuted: boolean;
} = ...

Type declaration

isMusicMuted: boolean
isSFXMuted: boolean

`Private` _events

_events: EventLite = ...

`Private` gp

isMusicMuted

isMusicMuted: boolean = false

isSFXMuted

isSFXMuted: boolean = false

Accessors

isMuted

get isMuted(): boolean
Returns boolean
- Defined in core/sounds/Sounds.ts:60

Methods

`Private` #muteMusic

#muteMusic(emitGlobalEvent?): void
Parameters
- emitGlobalEvent: boolean = true
Returns void
- Defined in core/sounds/Sounds.ts:129

`Private` #muteSFX

#muteSFX(emitGlobalEvent?): void
Parameters
- emitGlobalEvent: boolean = true
Returns void
- Defined in core/sounds/Sounds.ts:101

`Private` #saveToStorage

#saveToStorage(): void
Returns void
- Defined in core/sounds/Sounds.ts:157

`Private` #unmuteMusic

#unmuteMusic(emitGlobalEvent?): void
Parameters
- emitGlobalEvent: boolean = true
Returns void
- Defined in core/sounds/Sounds.ts:143

`Private` #unmuteSFX

#unmuteSFX(emitGlobalEvent?): void
Parameters
- emitGlobalEvent: boolean = true
Returns void
- Defined in core/sounds/Sounds.ts:115

mute

mute(): void
Returns void
- Defined in core/sounds/Sounds.ts:64

muteMusic

muteMusic(): void
Returns void
- Defined in core/sounds/Sounds.ts:169

muteSFX

muteSFX(): void
Returns void
- Defined in core/sounds/Sounds.ts:161

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof SoundsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: SoundsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof SoundsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: SoundsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof SoundsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: SoundsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15

unmute

unmute(): void
Returns void
- Defined in core/sounds/Sounds.ts:83

unmuteMusic

unmuteMusic(): void
Returns void
- Defined in core/sounds/Sounds.ts:173

unmuteSFX

unmuteSFX(): void
Returns void
- Defined in core/sounds/Sounds.ts:165