import Audio from 'WTF-Adventure/WTF-Adventure/client/controllers/audio.js'

public class | source

Audio

Controls audio and sfx in the game

Constructor Summary

Public Constructor
public	constructor(instance: Game) Default constructor

Member Summary

Public Members
public	audibles: Object An object with all of the music and sfxs
public	enabled: Boolean Whether or not music is on in the game
public	format: String The format of the audibles
public	game: Game An instance of the game
public	music: Object All the music in the game
public	sfx: Object All the SFX in the game
public	song: Object An instance of the song
public	songName: String The name of the song

Method Summary

Public Methods
public	clearFadeIn(): Boolean Clear the fade in interval
public	clearFadeOut(): Boolean Clears the fade out interval
public	fadeIn(): Boolean Fade in the active song
public	fadeOut(callback: Function): Boolean Fade out the active song
public	fadeSongOut(): Boolean Triggers the song to fade out and then resets it
public	fileExists(name: String): Boolean checks to see if this song file exists in the music list
public	get(name: String): Boolean Return the song
public	getMusic(name: String): {sound: HTMLAudioElement, name: String} Returns an object with the sound and the name of the sound
public	getMusicVolume(): Number Return the music volume
public	getSFXVolume(): Number Return the SFX volume
public	isEnabled(): Boolean Returns true if the users sound is enabled
public	loadAudio() Loads the music and sfx in the game
public	parse(path: String, name: String, channels: Array, callback: Function) Default constructor
public	play(type: String, name: String): Boolean Play a specific audio file
public	reset(song: *): Boolean Resets a song so that it's ready to play from the beginning again
public	setSongVolume(volume: Number): Boolean Set the volume level on the sound
public	stop(): Boolean Stop playing a song
public	update(): Boolean Update a song to replay, fade in, fade out or reset

Public Constructors

public constructor(instance: Game) source

Default constructor

Params:

Name	Type	Attribute	Description
instance	Game		of the game

Public Members

public audibles: Object source

An object with all of the music and sfxs

public enabled: Boolean source

Whether or not music is on in the game

public format: String source

The format of the audibles

public game: Game source

An instance of the game

public music: Object source

All the music in the game

public sfx: Object source

All the SFX in the game

public song: Object source

An instance of the song

public songName: String source

The name of the song

Public Methods

public clearFadeIn(): Boolean source

Clear the fade in interval

Return:

Boolean

public clearFadeOut(): Boolean source

Clears the fade out interval

Return:

Boolean

public fadeIn(): Boolean source

Fade in the active song

Return:

Boolean

public fadeOut(callback: Function): Boolean source

Fade out the active song

Params:

Name	Type	Attribute	Description
callback	Function		trigger this callback when the fade out is done

Return:

Boolean

public fadeSongOut(): Boolean source

Triggers the song to fade out and then resets it

Return:

Boolean

public fileExists(name: String): Boolean source

checks to see if this song file exists in the music list

Params:

Name	Type	Attribute	Description
name	String		the name of the song

Return:

Boolean

returns true if it exists

public get(name: String): Boolean source

Return the song

Params:

Name	Type	Attribute	Description
name	String		the name of the song

Return:

Boolean

public getMusic(name: String): {sound: HTMLAudioElement, name: String} source

Returns an object with the sound and the name of the sound

Params:

Name	Type	Attribute	Description
name	String		the name of the music

Return:

{sound: HTMLAudioElement, name: String}

public getMusicVolume(): Number source

Return the music volume

Return:

Number

public getSFXVolume(): Number source

Return the SFX volume

Return:

Number

public isEnabled(): Boolean source

Returns true if the users sound is enabled

Return:

Boolean

public loadAudio() source

Loads the music and sfx in the game

public parse(path: String, name: String, channels: Array, callback: Function) source

Default constructor

Params:

Name	Type	Attribute	Description
path	String		to the audio file
name	String		the name of the audio file
channels	Array		an array of audio channels
callback	Function		the function to call when done parsing the audio file