be.seeseemelk.mockbukkit.sound

Class AudioExperience

java.lang.Object

be.seeseemelk.mockbukkit.sound.AudioExperience

public final class AudioExperience
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
AudioExperience(@NotNull org.bukkit.Sound sound, @NotNull org.bukkit.SoundCategory category, @NotNull org.bukkit.Location loc, float volume, float pitch)
AudioExperience(@NotNull java.lang.String sound, @NotNull org.bukkit.SoundCategory category, @NotNull org.bukkit.Location loc, float volume, float pitch)

Method Summary

Modifier and Type	Method and Description
@NotNull org.bukkit.SoundCategory	getCategory() This method returns the SoundCategory with which the Sound was played.
@NotNull org.bukkit.Location	getLocation() This returns the Location at which this Sound was played.
float	getPitch() The pitch of this Sound
@NotNull java.lang.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 Detail

AudioExperience

public AudioExperience(@NotNull
                       @NotNull java.lang.String sound,
                       @NotNull
                       @NotNull org.bukkit.SoundCategory category,
                       @NotNull
                       @NotNull org.bukkit.Location loc,
                       float volume,
                       float pitch)

AudioExperience

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

Method Detail

getSound

@NotNull
public @NotNull java.lang.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 org.bukkit.SoundCategory getCategory()

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

Returns:

The SoundCategory

getLocation

@NotNull
public @NotNull org.bukkit.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