Class AudioSprite<K>

A typed registry and lifetime owner for the ordinary Sounds in an atlas. Playback and configuration remain child-Sound operations.

Type Parameters

K extends string = string

Index

Constructors

Properties

Methods

cleanup get has

Constructors

constructor

new AudioSprite<K extends string = string>(
sounds: Record<K, Sound>,
names: readonly K[],
): AudioSprite<K>
Internal
Construct sprites through Cacophony.createSprite().
Type Parameters
- K extends string = string
Parameters
- sounds: Record<K, Sound>
- names: readonly K[]
Returns AudioSprite<K>
- Defined in src/audioSprite.ts:30

Properties

`Readonly`names

names: readonly K[]

`Readonly`sounds

sounds: Readonly<Record<K, Sound>>

Methods

cleanup

cleanup(): void
Returns void
- Defined in src/audioSprite.ts:46

get

get(name: K): Sound
Parameters
- name: K
Returns Sound
- Defined in src/audioSprite.ts:35

has

has(name: string): name is K
Parameters
- name: string
Returns name is K
- Defined in src/audioSprite.ts:42