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

SPIGOT-7422, : Add API to set sherds on decorated pots

Browse source 
By: Parker Hawke <hawkeboyz2@hotmail.com>
This commit is contained in:
Bukkit/Spigot 2023-07-19 07:41:29 +10:00
parent a8b458f9dc
commit e8181b5107
1 changed files with 49 additions and 4 deletions

53
paper-api/src/main/java/org/bukkit/block/DecoratedPot.java
View file

@ -1,21 +1,66 @@
package org.bukkit.block;
import java.util.List;
import java.util.Map;
import org.bukkit.Material;
import org.jetbrains.annotations.ApiStatus;
import org.bukkit.Tag;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Represents a captured state of a decorated pot.
*/
@ApiStatus.Experimental
public interface DecoratedPot extends TileState {
/**
* Gets the shards which will be dropped when this pot is broken.
* Set the sherd on the provided side.
*
* @return shards
* @param side the side to set
* @param sherd the sherd, or null to set a blank side.
* @throws IllegalArgumentException if the sherd is not either
* tagged by {@link Tag#ITEMS_DECORATED_POT_SHERDS}, {@link Material#BRICK},
* or {@code null}
*/
public void setSherd(@NotNull Side side, @Nullable Material sherd);
/**
* Get the sherd on the provided side.
*
* @param side the side to get
* @return the sherd on the side or {@link Material#BRICK} if it's blank
*/
@NotNull
public Material getSherd(@NotNull Side side);
/**
* Gets a Map of all sides on this decorated pot and the sherds on them.
* If a side does not have a specific sherd on it, {@link Material#BRICK}
* will be the value of that side.
*
* @return the sherds
*/
@NotNull
public Map<Side, Material> getSherds();
/**
* Gets the sherds on this decorated pot. For faces without a specific sherd,
* {@link Material#BRICK} is used in its place.
*
* @return the sherds
* @deprecated in favor of {@link #getSherds()}
*/
@Deprecated
@NotNull
public List<Material> getShards();
/**
* A side on a decorated pot. Sides are relative to the facing state of a
* {@link org.bukkit.block.data.type.DecoratedPot}.
*/
public static enum Side {
BACK,
LEFT,
RIGHT,
FRONT
}
}