Package be.seeseemelk.mockbukkit.sound

Class AudioExperience

java.lang.Object

be.seeseemelk.mockbukkit.sound.AudioExperience

public final class AudioExperience
extends Object

This class represents a Sound that was heard by a Player.

Constructor Summary

Constructors

Constructor	Description
AudioExperience(@NotNull String sound, @NotNull SoundCategory category, @NotNull Location loc, float volume, float pitch)
AudioExperience(@NotNull Sound sound, @NotNull SoundCategory category, @NotNull Location loc, float volume, float pitch)

Method Summary

Modifier and Type	Method	Description
@NotNull SoundCategory	getCategory()	This method returns the SoundCategory with which the Sound was played.
@NotNull Location	getLocation()	This returns the Location at which this Sound was played.
float	getPitch()	The pitch of this Sound
@NotNull String	getSound()	This returns the Sound that was played.
float	getVolume()	The volume of this Sound

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AudioExperience

public AudioExperience(@NotNull
 @NotNull String sound,
 @NotNull
 @NotNull SoundCategory category,
 @NotNull
 @NotNull Location loc,
 float volume,
 float pitch)

AudioExperience

public AudioExperience(@NotNull
 @NotNull Sound sound,
 @NotNull
 @NotNull SoundCategory category,
 @NotNull
 @NotNull Location loc,
 float volume,
 float pitch)

Method Details

getSound

@NotNull
public @NotNull String getSound()

This returns the Sound that was played. We return the String representation of the actual sound, not the sound itself.

Returns:

The String of the heard Sound.

getCategory

@NotNull
public @NotNull SoundCategory getCategory()

This method returns the SoundCategory with which the Sound was played.

Returns:

The SoundCategory

getLocation

@NotNull
public @NotNull Location getLocation()

This returns the Location at which this Sound was played.

Returns:

The Location

getVolume

public float getVolume()

The volume of this Sound

Returns:

The volume

getPitch

public float getPitch()

The pitch of this Sound

Returns:

The pitch