Package net.kyori.adventure.sound

Enum Sound.Source

java.lang.Object

java.lang.Enum<Sound.Source>

net.kyori.adventure.sound.Sound.Source

All Implemented Interfaces:

Serializable, Comparable<Sound.Source>

Enclosing interface:

Sound

public static enum Sound.Source
extends Enum<Sound.Source>

The sound source.

The documentation for each source details the vanilla use.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Sound.Source.Provider	A provider of sound sources.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMBIENT	The ambient sound source.
BLOCK	The block sound source.
HOSTILE	The hostile sound source.
MASTER	The main sound source.
MUSIC	The music sound source.
NEUTRAL	The neutral sound source.
PLAYER	The player sound source.
RECORD	The record sound source.
UI	The UI sound source.
VOICE	The voice sound source.
WEATHER	The weather sound source.

Field Summary

Fields

Modifier and Type	Field	Description
static final Index<String,Sound.Source>	NAMES	The name map.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MASTER

public static final Sound.Source MASTER

The main sound source.

This source controls the overall sound of the game.

Since:

4.0.0

MUSIC

public static final Sound.Source MUSIC

The music sound source.

This source handles the in-game soundtrack.

Since:

4.0.0

RECORD

public static final Sound.Source RECORD

The record sound source.

This source handles jukeboxes and note blocks.

Since:

4.0.0

WEATHER

public static final Sound.Source WEATHER

The weather sound source.

This source handles weather sounds.

Since:

4.0.0

BLOCK

public static final Sound.Source BLOCK

The block sound source.

This source handles player interaction with blocks as well as passive block sounds.

Since:

4.0.0

HOSTILE

public static final Sound.Source HOSTILE

The hostile sound source.

This source handles hostile entities.

Since:

4.0.0

NEUTRAL

public static final Sound.Source NEUTRAL

The neutral sound source.

This source handles neutral entities.

Since:

4.0.0

PLAYER

public static final Sound.Source PLAYER

The player sound source.

This source handles player entities.

Since:

4.0.0

AMBIENT

public static final Sound.Source AMBIENT

The ambient sound source.

This source handles ambience.

Since:

4.0.0

VOICE

public static final Sound.Source VOICE

The voice sound source.

This source handles the narrator.

Since:

4.0.0

UI

public static final Sound.Source UI

The UI sound source.

This source handles UI actions.

Since:

4.22.0

Since Minecraft:

1.21.6

Field Details

NAMES

public static final Index<String,Sound.Source> NAMES

The name map.

Since:

4.0.0

Method Details

values

public static Sound.Source[] values()

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

Returns:

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

valueOf

public static Sound.Source valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null