Package games.stendhal.common.constants

Enum Class SoundLayer

java.lang.Object

java.lang.Enum<SoundLayer>

games.stendhal.common.constants.SoundLayer

All Implemented Interfaces:

Serializable, Comparable<SoundLayer>, Constable

public enum SoundLayer
extends Enum<SoundLayer>

the layer on which a sound is played

Author:

hendrik

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMBIENT_SOUND	sounds that are related to the zone and are in-game, like a waterfall, wind, the hammering at the blacksmith
BACKGROUND_MUSIC	nice background music which is considered out-of-game
CREATURE_NOISE	noise made by creatures and NPCs
FIGHTING_NOISE	noise made by weapons and armor
USER_INTERFACE	user interface feedback, opening of windows, private message notification

Field Summary

Fields

Modifier and Type	Field	Description
String	groupName	the internal name of the sound layer

Method Summary

Modifier and Type	Method	Description
static SoundLayer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SoundLayer[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BACKGROUND_MUSIC

public static final SoundLayer BACKGROUND_MUSIC

nice background music which is considered out-of-game

AMBIENT_SOUND

public static final SoundLayer AMBIENT_SOUND

sounds that are related to the zone and are in-game, like a waterfall, wind, the hammering at the blacksmith

CREATURE_NOISE

public static final SoundLayer CREATURE_NOISE

noise made by creatures and NPCs

FIGHTING_NOISE

public static final SoundLayer FIGHTING_NOISE

noise made by weapons and armor

USER_INTERFACE

public static final SoundLayer USER_INTERFACE

user interface feedback, opening of windows, private message notification

Field Details

groupName

public final String groupName

the internal name of the sound layer

Method Details

values

public static SoundLayer[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SoundLayer valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null