Interface UnsafeValues

@Deprecated(since="1.7.2")
public interface UnsafeValues

Deprecated.

This interface provides value conversions that may be specific to a runtime, or have arbitrary meaning (read: magic values).

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.

Method Summary

Modifier and Type	Method	Description
void	checkSupported(PluginDescriptionFile pdf)	Deprecated.
default @NotNull Entity	deserializeEntity(byte @NotNull [] data, @NotNull World world)	Deprecated. Deserializes the entity from data.
default @NotNull Entity	deserializeEntity(byte @NotNull [] data, @NotNull World world, boolean preserveUUID)	Deprecated. Deserializes the entity from data.
@NotNull Entity	deserializeEntity(byte @NotNull [] data, @NotNull World world, boolean preserveUUID, boolean preservePassengers)	Deprecated. Deserializes the entity from data.
@NotNull ItemStack	deserializeItemFromJson(JsonObject data)	Deprecated. Creates an itemstack from a json object.
@NotNull ItemStack	deserializeItemHover(@NotNull HoverEvent.ShowItem itemHover)	Deprecated. Deserializes a HoverEvent.ShowItem hover event value into an ItemStack.
@NotNull ItemStack	deserializeStack(@NotNull Map<String,Object> args)	Deprecated.
Material	fromLegacy(Material material)	Deprecated.
Material	fromLegacy(MaterialData material)	Deprecated.
Material	fromLegacy(MaterialData material, boolean itemPriority)	Deprecated.
BlockData	fromLegacy(Material material, byte data)	Deprecated.
<B extends Keyed> B	get(RegistryKey<B> registry, NamespacedKey key)	Deprecated.
String	get(Class<?> elementClass, String value)	Deprecated.
int	getDataVersion()	Deprecated.
PotionType.InternalPotionData	getInternalPotionData(NamespacedKey key)	Deprecated, for removal: This API element is subject to removal in a future version.
@NotNull String	getMainLevelName()	Deprecated. Just don't use it.
Material	getMaterial(String material, int version)	Deprecated.
int	getProtocolVersion()	Deprecated. Returns the server's protocol version.
static boolean	isLegacyPlugin(Plugin plugin)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isSupportedApiVersion(String apiVersion)	Deprecated, for removal: This API element is subject to removal in a future version.
@Nullable Advancement	loadAdvancement(Key key, String advancement, boolean persist)	Deprecated. Load an advancement represented by the specified string into the server.
default @Nullable Advancement	loadAdvancement(NamespacedKey key, String advancement)	Deprecated. Load an advancement represented by the specified string into the server.
List<Advancement>	loadAdvancements(Map<Key,String> advancements, boolean persist)	Deprecated. Load multiple advancements represented by the specified strings into the server.
ItemStack	modifyItemStack(ItemStack item, String components)	Deprecated.
int	nextEntityId(World world)	Deprecated. Creates and returns the next EntityId available.
byte[]	processClass(PluginDescriptionFile pdf, String path, byte[] clazz)	Deprecated.
boolean	removeAdvancement(NamespacedKey key)	Deprecated. Delete an advancement which was loaded and saved by loadAdvancement(Key, String, boolean) or loadAdvancements(Map, boolean).
default byte @NotNull []	serializeEntity(@NotNull Entity entity)	Deprecated. Serializes the provided entity.
byte @NotNull []	serializeEntity(@NotNull Entity entity, @NotNull EntitySerializationFlag... serializationFlags)	Deprecated. Serializes the provided entity.
JsonObject	serializeItemAsJson(@NotNull ItemStack itemStack)	Deprecated. Serializes this itemstack to json format.
Material	toLegacy(Material material)	Deprecated.

Method Details

toLegacy

Material toLegacy(Material material)

Deprecated.

fromLegacy

Material fromLegacy(Material material)

Deprecated.

fromLegacy

Material fromLegacy(MaterialData material)

Deprecated.

fromLegacy

Material fromLegacy(MaterialData material,
 boolean itemPriority)

Deprecated.

fromLegacy

BlockData fromLegacy(Material material,
 byte data)

Deprecated.

getMaterial

Material getMaterial(String material,
 int version)

Deprecated.

getDataVersion

int getDataVersion()

Deprecated.

modifyItemStack

ItemStack modifyItemStack(ItemStack item,
 String components)

Deprecated.

checkSupported

void checkSupported(PluginDescriptionFile pdf)
             throws InvalidPluginException

Deprecated.

Throws:

InvalidPluginException

processClass

byte[] processClass(PluginDescriptionFile pdf,
 String path,
 byte[] clazz)

Deprecated.

loadAdvancement

@Nullable
default @Nullable Advancement loadAdvancement(NamespacedKey key,
 @Language("json")
 String advancement)

Deprecated.

Load an advancement represented by the specified string into the server. The advancement format is governed by Minecraft and has no specified layout.

It is currently a JSON object, as described by the Minecraft wiki.

Loaded advancements will be stored and persisted across server restarts and reloads.

Parameters:

key - the unique advancement key

advancement - representation of the advancement

Returns:

the loaded advancement or null if an error occurred

loadAdvancement

@Nullable
@Nullable Advancement loadAdvancement(Key key,
 @Language("json")
 String advancement,
 boolean persist)

Deprecated.

Load an advancement represented by the specified string into the server. The advancement format is governed by Minecraft and has no specified layout.

It is currently a JSON object, as described by the Minecraft wiki.

Loaded advancements will only be stored and persisted across server restarts and reloads, if the persist parameter is set to true.

Parameters:

key - the unique advancement key

advancement - representation of the advancement

persist - whether to store this advancement in the bukkit datapack for persistence

Returns:

the loaded advancement or null if an error occurred

loadAdvancements

List<Advancement> loadAdvancements(Map<Key,String> advancements,
 boolean persist)

Deprecated.

Load multiple advancements represented by the specified strings into the server. The advancement format is governed by Minecraft and has no specified layout.

It is currently a JSON object, as described by the Minecraft wiki.

Loaded advancements will only be stored and persisted across server restarts and reloads, if the persist parameter is set to true.

Callers should be prepared for Exception to be thrown.

Parameters:

advancements - the advancements to register. The key is the unique advancement key and the value is the advancement's JSON representation

persist - whether to store this advancement in the bukkit datapack for persistence

Returns:

list of all successfully loaded advancements

removeAdvancement

boolean removeAdvancement(NamespacedKey key)

Deprecated.

Delete an advancement which was loaded and saved by loadAdvancement(Key, String, boolean) or loadAdvancements(Map, boolean).

This method will only remove advancement from persistent storage. It should be accompanied by a call to Server.reloadData() in order to fully remove it from the running instance.

Parameters:

key - the unique advancement key

Returns:

true if a file matching this key was found and deleted

getInternalPotionData

@Internal
@Deprecated(since="1.20.2",
            forRemoval=true)
PotionType.InternalPotionData getInternalPotionData(NamespacedKey key)

Deprecated, for removal: This API element is subject to removal in a future version.

Do not use, method will get removed, and the plugin won't run

Parameters:

key - of the potion type

Returns:

an internal potion data

get

@Internal
String get(Class<?> elementClass,
 String value)

Deprecated.

get

@Internal
@Nullable
<B extends Keyed> B get(RegistryKey<B> registry,
 NamespacedKey key)

Deprecated.

isSupportedApiVersion

@Deprecated(forRemoval=true)
boolean isSupportedApiVersion(String apiVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

isLegacyPlugin

@Deprecated(forRemoval=true)
static boolean isLegacyPlugin(Plugin plugin)

Deprecated, for removal: This API element is subject to removal in a future version.

serializeItemAsJson

@NotNull
JsonObject serializeItemAsJson(@NotNull
 @NotNull ItemStack itemStack)

Deprecated.

Serializes this itemstack to json format. It is safe for data migrations as it will use the built-in data converter instead of bukkit's dangerous serialization system.

The emitted json object's format will inherently change across versions and hence should not be used for non-development purposes like plugin configurations or end-user input.

Returns:

json object representing this item.

Throws:

IllegalArgumentException - if the passed itemstack is ItemStack.empty().

See Also:

• deserializeItemFromJson(com.google.gson.JsonObject)

deserializeItemFromJson

@NotNull
@NotNull ItemStack deserializeItemFromJson(@NotNull
 JsonObject data)
                                    throws IllegalArgumentException

Deprecated.

Creates an itemstack from a json object.

This method expects a json object in the format emitted by serializeItemAsJson(ItemStack).

The emitted json object's format will inherently change across versions and hence should not be used for non-development purposes like plugin configurations or end-user input.

Parameters:

data - object representing an item in Json format

Returns:

the deserialize item stack, migrated to the latest data version if needed.

Throws:

IllegalArgumentException - if the json object is not a valid item

See Also:

• serializeItemAsJson(ItemStack)

serializeEntity

default byte @NotNull [] serializeEntity(@NotNull
 @NotNull Entity entity)

Deprecated.

Serializes the provided entity.

Parameters:

entity - entity

Returns:

serialized entity data

Throws:

IllegalArgumentException - if couldn't serialize the entity

Since:

1.17.1

See Also:

• serializeEntity(Entity, EntitySerializationFlag...)
• deserializeEntity(byte[], World, boolean, boolean)

serializeEntity

byte @NotNull [] serializeEntity(@NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull EntitySerializationFlag... serializationFlags)

Deprecated.

Serializes the provided entity.

Parameters:

entity - entity

serializationFlags - serialization flags

Returns:

serialized entity data

Throws:

IllegalArgumentException - if couldn't serialize the entity

Since:

1.21.4

See Also:

• deserializeEntity(byte[], World, boolean, boolean)

deserializeEntity

@NotNull
default @NotNull Entity deserializeEntity(byte @NotNull [] data,
 @NotNull
 @NotNull World world)

Deprecated.

Deserializes the entity from data.
The entity's UUID as well as passengers will not be preserved.

Parameters:

data - serialized entity data

world - world

Returns:

deserialized entity

Throws:

IllegalArgumentException - if invalid serialized entity data provided

Since:

1.17.1

See Also:

• deserializeEntity(byte[], World, boolean, boolean)
• serializeEntity(Entity, EntitySerializationFlag...)
• Entity.spawnAt(Location, CreatureSpawnEvent.SpawnReason)

deserializeEntity

@NotNull
default @NotNull Entity deserializeEntity(byte @NotNull [] data,
 @NotNull
 @NotNull World world,
 boolean preserveUUID)

Deprecated.

Deserializes the entity from data.
The entity's passengers will not be preserved.

Parameters:

data - serialized entity data

world - world

preserveUUID - whether to preserve the entity's uuid

Returns:

deserialized entity

Throws:

IllegalArgumentException - if invalid serialized entity data provided

Since:

1.17.1

See Also:

• deserializeEntity(byte[], World, boolean, boolean)
• serializeEntity(Entity, EntitySerializationFlag...)
• Entity.spawnAt(Location, CreatureSpawnEvent.SpawnReason)

deserializeEntity

@NotNull
@NotNull Entity deserializeEntity(byte @NotNull [] data,
 @NotNull
 @NotNull World world,
 boolean preserveUUID,
 boolean preservePassengers)

Deprecated.

Deserializes the entity from data.

Parameters:

data - serialized entity data

world - world

preserveUUID - whether to preserve uuids of the entity and its passengers

preservePassengers - whether to preserve passengers

Returns:

deserialized entity

Throws:

IllegalArgumentException - if invalid serialized entity data provided

Since:

1.21.4

See Also:

• serializeEntity(Entity, EntitySerializationFlag...)
• Entity.spawnAt(Location, CreatureSpawnEvent.SpawnReason)

nextEntityId

int nextEntityId(World world)

Deprecated.

Creates and returns the next EntityId available.

Use this when sending custom packets, so that there are no collisions on the client or server.

getMainLevelName

@NotNull
@NotNull String getMainLevelName()

Deprecated.

Just don't use it.

getProtocolVersion

int getProtocolVersion()

Deprecated.

Returns the server's protocol version.

Returns:

the server's protocol version

deserializeStack

@NotNull
@NotNull ItemStack deserializeStack(@NotNull
 @NotNull Map<String,Object> args)

Deprecated.

deserializeItemHover

@NotNull
@NotNull ItemStack deserializeItemHover(@NotNull HoverEvent.ShowItem itemHover)

Deprecated.

Deserializes a HoverEvent.ShowItem hover event value into an ItemStack.

Parameters:

itemHover - the hover to deserialize

Returns:

the deserialized ItemStack