Class SoundEffectComponent

SoundEffect provides a set of sounds associated with events that can happen to an actor. This lets us easily know which sound to play without having to rely on a callback. Note that this component has the full set of possible sounds, even though not all are appropriate for any single actor.

Constructors

constructor

Properties

arrive collide defeat disappear jump toss

Constructors

constructor

  • new SoundEffectComponent(config): SoundEffectComponent

  • Construct a SoundEffectComponent from the file names of the sounds to play on events.

    Parameters

    • config: {
          arrive?: string;
          collide?: string;
          defeat?: string;
          disappear?: string;
          jump?: string;
          toss?: string;
      }

      An object with the names of the sounds for events for which a sound should play

      • Optional arrive?: string

        The sound to play upon arrival at a destination

      • Optional collide?: string

        The sound to play when there is a collision with this actor

      • Optional defeat?: string

        The sound to play when the actor is defeated

      • Optional disappear?: string

        The sound to play when the actor disappears

      • Optional jump?: string

        The sound to play when the actor jumps

      • Optional toss?: string

        The sound to play when the actor tosses a projectile

    Returns SoundEffectComponent

Properties

arrive

arrive: undefined | ISound

Sound to play upon an arrival at a destination

collide

collide: undefined | ISound

Sound to play when there a collision with this actor

defeat

defeat: undefined | ISound

Sound to play when an actor is defeated

disappear

disappear: undefined | ISound

Sound to play when the actor disappears

jump

jump: undefined | ISound

Sound to play when an actor jumps

toss

toss: undefined | ISound

Sound to play when the actor tosses a projectile

Settings

Member Visibility

Theme

On This Page