Class SoundComponent

constructor

• new SoundComponent(props): SoundComponent

• Parameters

  • props: SoundComponentProps

  Returns SoundComponent

ReadonlyfilePath

asset

• get asset(): Nullable<SoundAsset>

• The asset of the sound

  Returns Nullable<SoundAsset>

  if the sound is fonud and loaded

isPlaying

• get isPlaying(): boolean

• This readonly property aims to indicate if the sound is playing. In this first MVP It is reset to false at any update and used only to trigger the sound at the next update

  Returns boolean

  true if the sound is set to be played at the next update.

load

• load(loader): void

• Loads the sound asset using the given loader. This method is implemented asynchronously so to not block the engine, as soon as the sound is loaded it will be played

  Parameters

  • loader: SoundLoader

  Returns void

play

• play(): void

• Flags the component as playing for the next update

  Returns void

toJson

• toJson(): WithType<SoundComponentProps>

• Returns WithType<SoundComponentProps>

update

• update(): void

• Plays the sound if loaded and flagged for playing at the next update. Flag is reset to false at the next update.

  Returns void