org.spongepowered.api.effect.sound

Interface SoundType

All Superinterfaces:

CatalogType

@CatalogedBy(value=SoundTypes.class)
public interface SoundType
extends CatalogType

Represents a sound that can be heard on clients.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SoundType.Builder Builds a SoundType, primarily for sending custom sounds to the client.

Method Summary

Modifier and Type	Method and Description
static SoundType.Builder	builder() Creates a new SoundType.Builder for building SoundTypes.
static SoundType	of(String id) Creates a newSoundType from the given ID.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static SoundType.Builder builder()

Creates a new SoundType.Builder for building SoundTypes.

Returns:

A new builder

of

static SoundType of(String id)

Creates a newSoundType from the given ID. To fetch existing types, use GameRegistry.getType(Class, String).

Parameters:

id - ID of the sound

Returns:

A new SoundType object