Package org.spongepowered.api.event.sound

Interface PlaySoundEvent

All Superinterfaces:

Cancellable, Event

All Known Subinterfaces:

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

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	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 player's on the Server.
static interface	PlaySoundEvent.FromJukebox	Fired when a record is inserted into a Jukebox
static interface	PlaySoundEvent.NoteBlock	Fired when a noteblock is triggered

Method Summary

Modifier and Type	Method	Description
ServerLocation	location()	Gets the location of the sound being played.
float	pitch()	Gets the pitch of the sound being played
Sound.Source	soundSource()	Gets the Sound.Source for the sound being played.
SoundType	soundType()	Gets the SoundType for the sound being played.
float	volume()	Gets the volume of the sound being played.

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

isCancelled, setCancelled

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

cause, context, source

Method Details

location

ServerLocation location()

Gets the location of the sound being played.

Returns:

the location of the sound being played

soundType

SoundType soundType()

Gets the SoundType for the sound being played.

Returns:

The SoundType

soundSource

Sound.Source soundSource()

Gets the Sound.Source for the sound being played.

Returns:

The Sound.Source

volume

float volume()

Gets the volume of the sound being played.

Returns:

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

pitch

float pitch()

Gets the pitch of the sound being played

Returns:

A float that represents the pitch.