Class SoundEffect

Hierarchy

SoundEffect

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SoundEffect(assetPath: string, loop: boolean): SoundEffect

- Defined in soundsystem/soundeffect.ts:30
Class constructor.

Parameters
- assetPath: string
- loop: boolean
Returns SoundEffect

Properties

Private _assetPath

_assetPath: string

Private _player

_player: undefined | HTMLAudioElement

Accessors

assetPath

get assetPath(): string

- Defined in soundsystem/soundeffect.ts:8
Gets the assets path.

Returns string
string

loop

get loop(): boolean
set loop(value: boolean): void

- Defined in soundsystem/soundeffect.ts:15
Gets if this sound is looping.

Returns boolean
boolean
- Defined in soundsystem/soundeffect.ts:22
Sets the sound to loop.

Parameters
- value: boolean
Returns void
boolean

Methods

destroy

destroy(): void

- Defined in soundsystem/soundeffect.ts:61
Destroys this sound.

Returns void
void

pause

pause(): void

- Defined in soundsystem/soundeffect.ts:46
Pauses this sound.

Returns void
void

play

play(): void

- Defined in soundsystem/soundeffect.ts:39
Plays this sound.

Returns void
void

stop

stop(): void

- Defined in soundsystem/soundeffect.ts:53
Stops this sound.

Returns void
void

Generated using TypeDoc