285 lines
11 KiB
Java
285 lines
11 KiB
Java
package org.bukkit;
|
|
|
|
import com.google.common.collect.Multimap;
|
|
import org.bukkit.advancement.Advancement;
|
|
import org.bukkit.attribute.Attribute;
|
|
import org.bukkit.attribute.AttributeModifier;
|
|
import org.bukkit.block.Biome;
|
|
import org.bukkit.block.data.BlockData;
|
|
import org.bukkit.damage.DamageEffect;
|
|
import org.bukkit.damage.DamageSource;
|
|
import org.bukkit.damage.DamageType;
|
|
import org.bukkit.entity.EntityType;
|
|
import org.bukkit.inventory.CreativeCategory;
|
|
import org.bukkit.inventory.EquipmentSlot;
|
|
import org.bukkit.inventory.ItemStack;
|
|
import org.bukkit.material.MaterialData;
|
|
import org.bukkit.plugin.InvalidPluginException;
|
|
import org.bukkit.plugin.PluginDescriptionFile;
|
|
import org.bukkit.potion.PotionType;
|
|
import org.jetbrains.annotations.ApiStatus;
|
|
import org.jetbrains.annotations.NotNull;
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
/**
|
|
* This interface provides value conversions that may be specific to a
|
|
* runtime, or have arbitrary meaning (read: magic values).
|
|
* <p>
|
|
* Their existence and behavior is not guaranteed across future versions. They
|
|
* may be poorly named, throw exceptions, have misleading parameters, or any
|
|
* other bad programming practice.
|
|
*/
|
|
@Deprecated(since = "1.7.2")
|
|
public interface UnsafeValues {
|
|
// Paper start
|
|
net.kyori.adventure.text.flattener.ComponentFlattener componentFlattener();
|
|
@Deprecated(forRemoval = true) net.kyori.adventure.text.serializer.plain.PlainComponentSerializer plainComponentSerializer();
|
|
@Deprecated(forRemoval = true) net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer plainTextSerializer();
|
|
@Deprecated(forRemoval = true) net.kyori.adventure.text.serializer.gson.GsonComponentSerializer gsonComponentSerializer();
|
|
@Deprecated(forRemoval = true) net.kyori.adventure.text.serializer.gson.GsonComponentSerializer colorDownsamplingGsonComponentSerializer();
|
|
@Deprecated(forRemoval = true) net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer legacyComponentSerializer();
|
|
net.kyori.adventure.text.Component resolveWithContext(net.kyori.adventure.text.Component component, org.bukkit.command.CommandSender context, org.bukkit.entity.Entity scoreboardSubject, boolean bypassPermissions) throws java.io.IOException;
|
|
// Paper end
|
|
|
|
Material toLegacy(Material material);
|
|
|
|
Material fromLegacy(Material material);
|
|
|
|
Material fromLegacy(MaterialData material);
|
|
|
|
Material fromLegacy(MaterialData material, boolean itemPriority);
|
|
|
|
BlockData fromLegacy(Material material, byte data);
|
|
|
|
Material getMaterial(String material, int version);
|
|
|
|
int getDataVersion();
|
|
|
|
ItemStack modifyItemStack(ItemStack stack, String arguments);
|
|
|
|
void checkSupported(PluginDescriptionFile pdf) throws InvalidPluginException;
|
|
|
|
byte[] processClass(PluginDescriptionFile pdf, String path, byte[] clazz);
|
|
|
|
/**
|
|
* Load an advancement represented by the specified string into the server.
|
|
* The advancement format is governed by Minecraft and has no specified
|
|
* layout.
|
|
* <br>
|
|
* It is currently a JSON object, as described by the <a href="https://minecraft.wiki/w/Advancements">Minecraft wiki</a>.
|
|
* <br>
|
|
* Loaded advancements will be stored and persisted across server restarts
|
|
* and reloads.
|
|
* <br>
|
|
* Callers should be prepared for {@link Exception} to be thrown.
|
|
*
|
|
* @param key the unique advancement key
|
|
* @param advancement representation of the advancement
|
|
* @return the loaded advancement or null if an error occurred
|
|
*/
|
|
Advancement loadAdvancement(NamespacedKey key, String advancement);
|
|
|
|
/**
|
|
* Delete an advancement which was loaded and saved by
|
|
* {@link #loadAdvancement(org.bukkit.NamespacedKey, java.lang.String)}.
|
|
* <br>
|
|
* This method will only remove advancement from persistent storage. It
|
|
* should be accompanied by a call to {@link Server#reloadData()} in order
|
|
* to fully remove it from the running instance.
|
|
*
|
|
* @param key the unique advancement key
|
|
* @return true if a file matching this key was found and deleted
|
|
*/
|
|
boolean removeAdvancement(NamespacedKey key);
|
|
|
|
@Deprecated(since = "1.21", forRemoval = true)
|
|
Multimap<Attribute, AttributeModifier> getDefaultAttributeModifiers(Material material, EquipmentSlot slot);
|
|
|
|
@Deprecated(since = "1.21", forRemoval = true)
|
|
CreativeCategory getCreativeCategory(Material material);
|
|
|
|
@Deprecated(since = "1.21", forRemoval = true)
|
|
String getBlockTranslationKey(Material material);
|
|
|
|
@Deprecated(since = "1.21", forRemoval = true)
|
|
String getItemTranslationKey(Material material);
|
|
|
|
String getTranslationKey(EntityType entityType);
|
|
|
|
String getTranslationKey(ItemStack itemStack);
|
|
|
|
@Deprecated(since = "1.21.3", forRemoval = true)
|
|
String getTranslationKey(Attribute attribute);
|
|
|
|
@Nullable
|
|
FeatureFlag getFeatureFlag(@NotNull NamespacedKey key);
|
|
|
|
/**
|
|
* Do not use, method will get removed, and the plugin won't run
|
|
*
|
|
* @param key of the potion type
|
|
* @return an internal potion data
|
|
*/
|
|
@ApiStatus.Internal
|
|
@Deprecated(since = "1.20.2", forRemoval = true)
|
|
PotionType.InternalPotionData getInternalPotionData(NamespacedKey key);
|
|
|
|
@ApiStatus.Internal
|
|
@Nullable
|
|
DamageEffect getDamageEffect(@NotNull String key);
|
|
|
|
/**
|
|
* Create a new {@link DamageSource.Builder}.
|
|
*
|
|
* @param damageType the {@link DamageType} to use
|
|
* @return a {@link DamageSource.Builder}
|
|
*/
|
|
@ApiStatus.Internal
|
|
@NotNull
|
|
DamageSource.Builder createDamageSourceBuilder(@NotNull DamageType damageType);
|
|
|
|
@ApiStatus.Internal
|
|
String get(Class<?> aClass, String value);
|
|
|
|
@ApiStatus.Internal
|
|
<B extends Keyed> B get(Registry<B> registry, NamespacedKey key);
|
|
|
|
@ApiStatus.Internal
|
|
Biome getCustomBiome();
|
|
|
|
// Paper start
|
|
@Deprecated(forRemoval = true)
|
|
boolean isSupportedApiVersion(String apiVersion);
|
|
|
|
@Deprecated(forRemoval = true)
|
|
static boolean isLegacyPlugin(org.bukkit.plugin.Plugin plugin) {
|
|
return !Bukkit.getUnsafe().isSupportedApiVersion(plugin.getDescription().getAPIVersion());
|
|
}
|
|
// Paper end
|
|
|
|
// Paper start
|
|
/**
|
|
* Called once by the version command on first use, then cached.
|
|
*/
|
|
default com.destroystokyo.paper.util.VersionFetcher getVersionFetcher() {
|
|
return new com.destroystokyo.paper.util.VersionFetcher.DummyVersionFetcher();
|
|
}
|
|
|
|
byte[] serializeItem(ItemStack item);
|
|
|
|
ItemStack deserializeItem(byte[] data);
|
|
|
|
byte[] serializeEntity(org.bukkit.entity.Entity entity);
|
|
|
|
default org.bukkit.entity.Entity deserializeEntity(byte[] data, World world) {
|
|
return deserializeEntity(data, world, false);
|
|
}
|
|
|
|
org.bukkit.entity.Entity deserializeEntity(byte[] data, World world, boolean preserveUUID);
|
|
|
|
/**
|
|
* Creates and returns the next EntityId available.
|
|
* <p>
|
|
* Use this when sending custom packets, so that there are no collisions on the client or server.
|
|
*/
|
|
public int nextEntityId();
|
|
|
|
/**
|
|
* Just don't use it.
|
|
*/
|
|
@org.jetbrains.annotations.NotNull String getMainLevelName();
|
|
|
|
/**
|
|
* Returns the server's protocol version.
|
|
*
|
|
* @return the server's protocol version
|
|
*/
|
|
int getProtocolVersion();
|
|
|
|
/**
|
|
* Checks if an itemstack can be repaired with another itemstack.
|
|
* Returns false if either argument's type is not an item ({@link Material#isItem()}).
|
|
*
|
|
* @param itemToBeRepaired the itemstack to be repaired
|
|
* @param repairMaterial the repair material
|
|
* @return true if valid repair, false if not
|
|
*/
|
|
public boolean isValidRepairItemStack(@org.jetbrains.annotations.NotNull ItemStack itemToBeRepaired, @org.jetbrains.annotations.NotNull ItemStack repairMaterial);
|
|
|
|
/**
|
|
* Checks if the entity represented by the namespaced key has default attributes.
|
|
*
|
|
* @param entityKey the entity's key
|
|
* @return true if it has default attributes
|
|
*/
|
|
boolean hasDefaultEntityAttributes(@org.jetbrains.annotations.NotNull NamespacedKey entityKey);
|
|
|
|
/**
|
|
* Gets the default attributes for the entity represented by the namespaced key.
|
|
*
|
|
* @param entityKey the entity's key
|
|
* @return an unmodifiable instance of Attributable for reading default attributes.
|
|
* @throws IllegalArgumentException if the entity does not exist of have default attributes (use {@link #hasDefaultEntityAttributes(NamespacedKey)} first)
|
|
*/
|
|
@org.jetbrains.annotations.NotNull org.bukkit.attribute.Attributable getDefaultEntityAttributes(@org.jetbrains.annotations.NotNull NamespacedKey entityKey);
|
|
// Paper end
|
|
|
|
// Paper start - namespaced key biome methods
|
|
/**
|
|
* Gets the {@link NamespacedKey} for the biome at the given location.
|
|
*
|
|
* @param accessor The {@link RegionAccessor} of the provided coordinates
|
|
* @param x X-coordinate of the block
|
|
* @param y Y-coordinate of the block
|
|
* @param z Z-coordinate of the block
|
|
* @deprecated custom biomes are properly supported in API now
|
|
* @return the biome's {@link NamespacedKey}
|
|
*/
|
|
@org.jetbrains.annotations.NotNull
|
|
@Deprecated(since = "1.21.3", forRemoval = true)
|
|
NamespacedKey getBiomeKey(RegionAccessor accessor, int x, int y, int z);
|
|
|
|
/**
|
|
* Sets the biome at the given location to a biome registered
|
|
* to the given {@link NamespacedKey}. If no biome by the given
|
|
* {@link NamespacedKey} exists, an {@link IllegalStateException}
|
|
* will be thrown.
|
|
*
|
|
* @param accessor The {@link RegionAccessor} of the provided coordinates
|
|
* @param x X-coordinate of the block
|
|
* @param y Y-coordinate of the block
|
|
* @param z Z-coordinate of the block
|
|
* @param biomeKey Biome key
|
|
* @deprecated custom biomes are properly supported in API now
|
|
* @throws IllegalStateException if no biome by the given key is registered.
|
|
*/
|
|
@Deprecated(since = "1.21.3", forRemoval = true)
|
|
void setBiomeKey(RegionAccessor accessor, int x, int y, int z, NamespacedKey biomeKey);
|
|
// Paper end - namespaced key biome methods
|
|
|
|
String getStatisticCriteriaKey(@NotNull org.bukkit.Statistic statistic); // Paper - fix custom stats criteria creation
|
|
|
|
// Paper start - spawn egg color visibility
|
|
/**
|
|
* Obtains the underlying color informating for a spawn egg of a given
|
|
* entity type, or null if the entity passed does not have a spawn egg.
|
|
* Spawn eggs have two colors - the background layer (0), and the
|
|
* foreground layer (1)
|
|
* @param entityType The entity type to get the color for
|
|
* @param layer The texture layer to get a color for
|
|
* @return The color of the layer for the entity's spawn egg
|
|
*/
|
|
@Nullable org.bukkit.Color getSpawnEggLayerColor(org.bukkit.entity.EntityType entityType, int layer);
|
|
// Paper end - spawn egg color visibility
|
|
|
|
// Paper start - lifecycle event API
|
|
/**
|
|
* @hidden
|
|
*/
|
|
@org.jetbrains.annotations.ApiStatus.Internal
|
|
io.papermc.paper.plugin.lifecycle.event.LifecycleEventManager<org.bukkit.plugin.Plugin> createPluginLifecycleEventManager(final org.bukkit.plugin.java.JavaPlugin plugin, final java.util.function.BooleanSupplier registrationCheck);
|
|
// Paper end - lifecycle event API
|
|
|
|
@NotNull java.util.List<net.kyori.adventure.text.Component> computeTooltipLines(@NotNull ItemStack itemStack, @NotNull io.papermc.paper.inventory.tooltip.TooltipContext tooltipContext, @Nullable org.bukkit.entity.Player player); // Paper - expose itemstack tooltip lines
|
|
}
|