Paper/patches/api/0180-Add-BlockSoundGroup-interface.patch

108 lines
3.5 KiB
Diff
Raw Normal View History

2021-06-11 14:02:28 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: simpleauthority <jacob@algorithmjunkie.com>
Date: Tue, 28 May 2019 03:41:28 -0700
Subject: [PATCH] Add BlockSoundGroup interface
This PR adds the getSoundGroup() method in Block which returns a BlockSoundGroup
diff --git a/src/main/java/com/destroystokyo/paper/block/BlockSoundGroup.java b/src/main/java/com/destroystokyo/paper/block/BlockSoundGroup.java
new file mode 100644
index 0000000000000000000000000000000000000000..ec36942128cbacae171584c89480b4aae3ae3e2f
2021-06-11 14:02:28 +02:00
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/block/BlockSoundGroup.java
@@ -0,0 +1,64 @@
2021-06-11 14:02:28 +02:00
+package com.destroystokyo.paper.block;
+
+import org.bukkit.Sound;
+import org.bukkit.block.Block;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Represents the sounds that a {@link Block} makes in certain situations
+ * <p>
+ * The sound group includes break, step, place, hit, and fall sounds.
+ * @deprecated use {@link org.bukkit.SoundGroup}
2021-06-11 14:02:28 +02:00
+ */
+@Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+public interface BlockSoundGroup {
+ /**
+ * Gets the sound that plays when breaking this block
+ *
+ * @return The break sound
+ * @deprecated use {@link org.bukkit.SoundGroup#getBreakSound()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ Sound getBreakSound();
+
+ /**
+ * Gets the sound that plays when stepping on this block
+ *
+ * @return The step sound
+ * @deprecated use {@link org.bukkit.SoundGroup#getStepSound()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ Sound getStepSound();
+
+ /**
+ * Gets the sound that plays when placing this block
+ *
+ * @return The place sound
+ * @deprecated use {@link org.bukkit.SoundGroup#getPlaceSound()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ Sound getPlaceSound();
+
+ /**
+ * Gets the sound that plays when hitting this block
+ *
+ * @return The hit sound
+ * @deprecated use {@link org.bukkit.SoundGroup#getHitSound()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ Sound getHitSound();
+
+ /**
+ * Gets the sound that plays when this block falls
+ *
+ * @return The fall sound
+ * @deprecated use {@link org.bukkit.SoundGroup#getFallSound()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ Sound getFallSound();
+}
diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java
index b101f5264bdde8bd14913d5161c1047020830f8d..db441e463b02ee734f85c855f5538cd41041dbae 100644
2021-06-11 14:02:28 +02:00
--- a/src/main/java/org/bukkit/block/Block.java
+++ b/src/main/java/org/bukkit/block/Block.java
@@ -606,4 +606,25 @@ public interface Block extends Metadatable {
2021-11-24 04:42:31 +01:00
* @return <code>true</code> if the block data can be placed here
2021-06-11 14:02:28 +02:00
*/
2021-11-24 04:42:31 +01:00
boolean canPlace(@NotNull BlockData data);
2021-06-11 14:02:28 +02:00
+
+ // Paper start
+ /**
+ * Gets the {@link com.destroystokyo.paper.block.BlockSoundGroup} for this block.
+ * <p>
+ * This object contains the block, step, place, hit, and fall sounds.
+ *
+ * @return the sound group for this block
+ * @deprecated use {@link #getBlockSoundGroup()}
2021-06-11 14:02:28 +02:00
+ */
+ @NotNull
+ @Deprecated(forRemoval = true)
2021-06-11 14:02:28 +02:00
+ com.destroystokyo.paper.block.BlockSoundGroup getSoundGroup();
+
+ /**
+ * Gets the {@link org.bukkit.SoundGroup} for this block.
+ *
+ * @return the sound group for this block
+ */
+ @NotNull org.bukkit.SoundGroup getBlockSoundGroup();
2021-06-11 14:02:28 +02:00
+ // Paper end
}