Class: AudioComponent

AudioComponent

FM.AudioComponent

new AudioComponent(pOwner)

Audio component to add to a game object for playing sounds.
Parameters:
Name Type Description
pOwner FM.GameObject Game object owner of this component.
Author:
  • Simon Chauvin
Source:

Extends

Members

name :FM.ComponentTypes

Component's name.
Type:
Inherited From:
Source:

owner :FM.GameObject

Component's owner.
Type:
Inherited From:
Source:

Methods

addSound(pSound)

Add a sound to the component.
Parameters:
Name Type Description
pSound FM.AudioAsset The sound to add to this component.
Source:

destroy()

Destroy the sound component and its objects.
Source:

getSoundByName(pSoundName) → {FM.AudioAsset}

Retrieve the audio object.
Parameters:
Name Type Description
pSoundName string The name of the sound to retrieve.
Source:
Returns:
The sound found or null if not.
Type
FM.AudioAsset

isPlaying(pSoundName) → {boolean}

Check if a sound is currently playing.
Parameters:
Name Type Description
pSoundName string The name of the sound to check.
Source:
Returns:
Whether the sound is playing or not.
Type
boolean

pause(pSoundName)

Pause the sound.
Parameters:
Name Type Description
pSoundName string The name of the sound to pause.
Source:

play(pSoundName, pVolume, pLoop)

Play the sound given a certain volume and whether the sound loops or not.
Parameters:
Name Type Description
pSoundName string The name of the sound to play.
pVolume float The volume at which playing the sound (0 to 1).
pLoop boolean Whether the sound should loop or not.
Source: