Enum Class SpeakerMode

java.lang.Object

java.lang.Enum<SpeakerMode>

fr.dreamin.dreamvoice.api.speaker.model.SpeakerMode

All Implemented Interfaces:

Serializable, Comparable<SpeakerMode>, Constable

public enum SpeakerMode
extends Enum<SpeakerMode>

Access mode for 3D locational speakers.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	Any nearby player can broadcast their voice through the speaker.
RESTRICTED	Only explicitly linked players can broadcast their voice.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GLOBAL

public static final SpeakerMode GLOBAL

Any nearby player can broadcast their voice through the speaker.

RESTRICTED

public static final SpeakerMode RESTRICTED

Only explicitly linked players can broadcast their voice.

Method Details

values

public static SpeakerMode[] 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 SpeakerMode 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