org.spongepowered.api.event.sound

Interface PlaySoundEvent

All Superinterfaces:

Cancellable, Event

All Known Subinterfaces:

PlaySoundEvent.AtEntity, PlaySoundEvent.Broadcast, PlaySoundEvent.NoteBlock, PlaySoundEvent.Record, PlaySoundEvent.Record.Start, PlaySoundEvent.Record.Stop

public interface PlaySoundEvent
extends Event, Cancellable

An umbrella event that fires when in-game sounds, such as records in jukeboxes or sounds when boss entities die.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PlaySoundEvent.AtEntity Fired when a sound is played at a specific Entity
static interface	PlaySoundEvent.Broadcast Fired when a sound is broadcasted to all Players on the server.
static interface	PlaySoundEvent.NoteBlock Fired when a noteblock is triggered
static interface	PlaySoundEvent.Record Fired when a record is inserted into a Jukebox

Method Summary

Modifier and Type	Method and Description
Location<World>	getLocation() Gets the location of the sound being played.
float	getPitch() Gets the pitch of the sound being played
SoundCategory	getSoundCategory() Gets the SoundCategory for the sound being played.
SoundType	getSoundType() Gets the SoundType for the sound being played.
float	getVolume() Gets the volume of the sound being played.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getLocation

Location<World> getLocation()

Gets the location of the sound being played.

Returns:

the location of the sound being played

getSoundCategory

SoundCategory getSoundCategory()

Gets the SoundCategory for the sound being played.

Returns:

The SoundCategory

getSoundType

SoundType getSoundType()

Gets the SoundType for the sound being played.

Returns:

SoundType

getVolume

float getVolume()

Gets the volume of the sound being played.

Returns:

A float that represents the relative volume. This value may be positive value.

getPitch

float getPitch()

Gets the pitch of the sound being played

Returns:

A float that represents the pitch.