-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add BlockData setter for FallingBlock (#9829)
- Loading branch information
Showing
5 changed files
with
158 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 | ||
| From: Owen1212055 <23108066+Owen1212055@users.noreply.github.com> | ||
| Date: Sun, 5 Dec 2021 14:58:55 -0500 | ||
| Subject: [PATCH] Expand FallingBlock API | ||
|
|
||
| - add auto expire setting | ||
| - add setter for block data | ||
| - add accessors for block state | ||
|
|
||
| Co-authored-by: Lukas Planz <lukas.planz@web.de> | ||
|
|
||
| diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java | ||
| index 109acbccfa0e5bcd32889e1911798176d600a5fc..8d861f5522a33669f67b3e41dfbc5234637114b4 100644 | ||
| --- a/src/main/java/org/bukkit/World.java | ||
| +++ b/src/main/java/org/bukkit/World.java | ||
| @@ -2241,8 +2241,10 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient | ||
| * @return The spawned {@link FallingBlock} instance | ||
| * @throws IllegalArgumentException if {@link Location} or {@link | ||
| * MaterialData} are null or {@link Material} of the {@link MaterialData} is not a block | ||
| + * @deprecated Use {@link #spawn(Location, Class, Consumer)} (or a variation thereof) in combination with {@link FallingBlock#setBlockData(BlockData)} | ||
| */ | ||
| @NotNull | ||
| + @Deprecated // Paper | ||
| public FallingBlock spawnFallingBlock(@NotNull Location location, @NotNull MaterialData data) throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| @@ -2255,8 +2257,10 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient | ||
| * @return The spawned {@link FallingBlock} instance | ||
| * @throws IllegalArgumentException if {@link Location} or {@link | ||
| * BlockData} are null | ||
| + * @deprecated Use {@link #spawn(Location, Class, Consumer)} (or a variation thereof) in combination with {@link FallingBlock#setBlockData(BlockData)} | ||
| */ | ||
| @NotNull | ||
| + @org.jetbrains.annotations.ApiStatus.Obsolete // Paper | ||
| public FallingBlock spawnFallingBlock(@NotNull Location location, @NotNull BlockData data) throws IllegalArgumentException; | ||
|
|
||
| /** | ||
| @@ -2273,7 +2277,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient | ||
| * @return The spawned {@link FallingBlock} instance | ||
| * @throws IllegalArgumentException if {@link Location} or {@link | ||
| * Material} are null or {@link Material} is not a block | ||
| - * @deprecated Magic value | ||
| + * @deprecated Magic value. Use {@link #spawn(Location, Class, Consumer)} (or a variation thereof) in combination with {@link FallingBlock#setBlockData(BlockData)} | ||
| */ | ||
| @Deprecated | ||
| @NotNull | ||
| diff --git a/src/main/java/org/bukkit/entity/FallingBlock.java b/src/main/java/org/bukkit/entity/FallingBlock.java | ||
| index ae1ce2ee2deb82f3f4144ec54b3ba119b437c5e9..a945e76dd61ef132ae3f3ee69635c927b1180523 100644 | ||
| --- a/src/main/java/org/bukkit/entity/FallingBlock.java | ||
| +++ b/src/main/java/org/bukkit/entity/FallingBlock.java | ||
| @@ -26,6 +26,33 @@ public interface FallingBlock extends Entity { | ||
| */ | ||
| @NotNull | ||
| BlockData getBlockData(); | ||
| + // Paper start | ||
| + /** | ||
| + * Sets the data for the falling block. | ||
| + * <br> | ||
| + * Any potential additional data currently stored in the falling blocks {@link #getBlockState()} will be | ||
| + * purged by calling this setter. | ||
| + * | ||
| + * @param blockData the data to use as the block | ||
| + */ | ||
| + void setBlockData(@NotNull BlockData blockData); | ||
| + | ||
| + /** | ||
| + * Get the data of the falling block represented as a {@link org.bukkit.block.BlockState BlockState} | ||
| + * which includes potential NBT data that gets applied when the block gets placed on landing. | ||
| + * | ||
| + * @return the BlockState representing this block | ||
| + */ | ||
| + @NotNull | ||
| + org.bukkit.block.BlockState getBlockState(); | ||
| + | ||
| + /** | ||
| + * Sets the {@link BlockData} and possibly present tile entity data for the falling block. | ||
| + * | ||
| + * @param blockState the BlockState to use | ||
| + */ | ||
| + void setBlockState(@NotNull org.bukkit.block.BlockState blockState); | ||
| + // Paper end | ||
|
|
||
| /** | ||
| * Get if the falling block will break into an item if it cannot be placed. | ||
| @@ -137,4 +164,23 @@ public interface FallingBlock extends Entity { | ||
| default org.bukkit.Location getSourceLoc() { | ||
| return this.getOrigin(); | ||
| } | ||
| + // Paper Start - Auto expire setting | ||
| + /** | ||
| + * Sets if this falling block should expire after: | ||
| + * - 30 seconds | ||
| + * - 5 seconds and is outside of the world | ||
| + * | ||
| + * @return if this behavior occurs | ||
| + */ | ||
| + boolean doesAutoExpire(); | ||
| + | ||
| + /** | ||
| + * Sets if this falling block should expire after: | ||
| + * - 30 seconds | ||
| + * - 5 seconds and is outside of the world | ||
| + * | ||
| + * @param autoExpires if this behavior should occur | ||
| + */ | ||
| + void shouldAutoExpire(boolean autoExpires); | ||
| + // Paper End - Auto expire setting | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters