vooga.gameEngine.event
Class AudioEvent

java.lang.Object
  java.util.EventObject
      vooga.gameEngine.event.AudioEvent

All Implemented Interfaces:

java.io.Serializable

public class AudioEvent
extends java.util.EventObject

Generated by GameRelatedObjects when a sound is desired to be played. Each sound event has a key which can be used in combination with a data structure or file to retrieve the proper audio clip.

Author:

Geoffrey Lawler

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

AudioEvent(java.lang.Object source, java.lang.String soundKey)
Default constructor for AudioEvent

Method Summary

java.lang.String

getSoundKey() Provides access to this Event's Audio Key which is intended to be used to retrieve and play a sound file.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AudioEvent

public AudioEvent(java.lang.Object source,
                  java.lang.String soundKey)

Default constructor for AudioEvent

Parameters:

source - The object firing this AudioEvent

soundKey - A key for mapping this event to a sound.

Method Detail

getSoundKey

public java.lang.String getSoundKey()

Provides access to this Event's Audio Key which is intended to be used to retrieve and play a sound file.

Returns:

A key used to map this event to a sound.