Package org.bukkit.inventory.meta.trim

Interface TrimMaterial

All Superinterfaces:

Keyed, Keyed, Translatable

public interface TrimMaterial
extends Keyed, Translatable

Represents a material that may be used in an ArmorTrim.

Field Summary

Fields

Modifier and Type	Field	Description
static final TrimMaterial	AMETHYST	Material.AMETHYST_SHARD.
static final TrimMaterial	COPPER	Material.COPPER_INGOT.
static final TrimMaterial	DIAMOND	Material.DIAMOND.
static final TrimMaterial	EMERALD	Material.EMERALD.
static final TrimMaterial	GOLD	Material.GOLD_INGOT.
static final TrimMaterial	IRON	Material.IRON_INGOT.
static final TrimMaterial	LAPIS	Material.LAPIS_LAZULI.
static final TrimMaterial	NETHERITE	Material.NETHERITE_INGOT.
static final TrimMaterial	QUARTZ	Material.QUARTZ.
static final TrimMaterial	REDSTONE	Material.REDSTONE.

Method Summary

Modifier and Type	Method	Description
@NotNull Component	description()	Get the description of this TrimMaterial.
@NotNull NamespacedKey	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.TRIM_MATERIAL.
@NotNull String	getTranslationKey()	Deprecated, for removal: This API element is subject to removal in a future version. this method assumes that description() will always be a translatable component which is not guaranteed.
default @NotNull Key	key()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.TRIM_MATERIAL.

Field Details

QUARTZ

static final TrimMaterial QUARTZ

Material.QUARTZ.

IRON

static final TrimMaterial IRON

Material.IRON_INGOT.

NETHERITE

static final TrimMaterial NETHERITE

Material.NETHERITE_INGOT.

REDSTONE

static final TrimMaterial REDSTONE

Material.REDSTONE.

COPPER

static final TrimMaterial COPPER

Material.COPPER_INGOT.

GOLD

static final TrimMaterial GOLD

Material.GOLD_INGOT.

EMERALD

static final TrimMaterial EMERALD

Material.EMERALD.

DIAMOND

static final TrimMaterial DIAMOND

Material.DIAMOND.

LAPIS

static final TrimMaterial LAPIS

Material.LAPIS_LAZULI.

AMETHYST

static final TrimMaterial AMETHYST

Material.AMETHYST_SHARD.

Method Details

description

@NotNull Component description()

Get the description of this TrimMaterial.

Returns:

the description

getTranslationKey

@Deprecated(forRemoval=true)
@NotNull
@NotNull String getTranslationKey()

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

this method assumes that description() will always be a translatable component which is not guaranteed.

Description copied from interface: Translatable

Get the translation key, suitable for use in a translation component.

Specified by:

getTranslationKey in interface Translatable

Returns:

the translation key

getKey

@Deprecated(forRemoval=true,
            since="1.20.4")
@NotNull NamespacedKey getKey()

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

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

key

@Deprecated(forRemoval=true,
            since="1.20.4")
default @NotNull Key key()

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

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.

Description copied from interface: Keyed

Returns the unique identifier for this object.

Specified by:

key in interface Keyed

Specified by:

key in interface Keyed

Returns:

this object's key