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 Description static interface
PlaySoundEvent.AtEntity
Fired when a sound is played at a specificEntity
static interface
PlaySoundEvent.Broadcast
static interface
PlaySoundEvent.NoteBlock
Fired when a noteblock is triggeredstatic interface
PlaySoundEvent.Record
Fired when a record is inserted into a Jukebox
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ServerLocation
location()
Gets the location of the sound being played.float
pitch()
Gets the pitch of the sound being playedSound.Source
soundSource()
Gets theSound.Source
for the sound being played.SoundType
soundType()
Gets theSoundType
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
-
-
-
-
Method Detail
-
location
ServerLocation location()
Gets the location of the sound being played.- Returns:
- the location of the sound being played
-
soundType
SoundType soundType()
Gets theSoundType
for the sound being played.- Returns:
- The
SoundType
-
soundSource
Sound.Source soundSource()
Gets theSound.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.
-
-