OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-09 03:43:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Implement SoundCategory for playing sounds.

Browse source 
By: LukBukkit <luk.bukkit@gmail.com>
This commit is contained in:
Bukkit/Spigot 2016-11-19 14:19:53 +11:00
parent 853b05b6ab
commit 1396386f23
3 changed files with 75 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
paper-api/src/main/java/org/bukkit/SoundCategory.java Normal file
View file

@ -0,0 +1,18 @@
package org.bukkit;
/**
* An Enum of categories for sounds.
*/
public enum SoundCategory {
MASTER,
MUSIC,
RECORDS,
WEATHER,
BLOCKS,
HOSTILE,
NEUTRAL,
PLAYERS,
AMBIENT,
VOICE;
}

28
paper-api/src/main/java/org/bukkit/World.java
View file

@ -1155,6 +1155,34 @@ public interface World extends PluginMessageRecipient, Metadatable {
*/
void playSound(Location location, String sound, float volume, float pitch);
/**
* Play a Sound at the provided Location in the World.
* <p>
* This function will fail silently if Location or Sound are null.
*
* @param location The location to play the sound
* @param sound The sound to play
* @param category the category of the sound
* @param volume The volume of the sound
* @param pitch The pitch of the sound
*/
void playSound(Location location, Sound sound, SoundCategory category, float volume, float pitch);
/**
* Play a Sound at the provided Location in the World.
* <p>
* This function will fail silently if Location or Sound are null. No sound
* will be heard by the players if their clients do not have the respective
* sound for the value passed.
*
* @param location the location to play the sound
* @param sound the internal sound name to play
* @param category the category of the sound
* @param volume the volume of the sound
* @param pitch the pitch of the sound
*/
void playSound(Location location, String sound, SoundCategory category, float volume, float pitch);
/**
* Get existing rules
*

29
paper-api/src/main/java/org/bukkit/entity/Player.java
View file

@ -13,6 +13,7 @@ import org.bukkit.Note;
import org.bukkit.OfflinePlayer;
import org.bukkit.Particle;
import org.bukkit.Sound;
import org.bukkit.SoundCategory;
import org.bukkit.Statistic;
import org.bukkit.WeatherType;
import org.bukkit.command.CommandSender;
@ -241,6 +242,34 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
*/
public void playSound(Location location, String sound, float volume, float pitch);
/**
* Play a sound for a player at the location.
* <p>
* This function will fail silently if Location or Sound are null.
*
* @param location The location to play the sound
* @param sound The sound to play
* @param category The category of the sound
* @param volume The volume of the sound
* @param pitch The pitch of the sound
*/
public void playSound(Location location, Sound sound, SoundCategory category, float volume, float pitch);
/**
* Play a sound for a player at the location.
* <p>
* This function will fail silently if Location or Sound are null. No sound
* will be heard by the player if their client does not have the respective
* sound for the value passed.
*
* @param location the location to play the sound
* @param sound the internal sound name to play
* @param category The category of the sound
* @param volume the volume of the sound
* @param pitch the pitch of the sound
*/
public void playSound(Location location, String sound, SoundCategory category, float volume, float pitch);
/**
* Stop the specified sound from playing.
*