Interface TrimMaterial

All Superinterfaces:

Keyed, Keyed, Translatable

@NullMarked
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
static final TrimMaterial	COPPER
static final TrimMaterial	DIAMOND
static final TrimMaterial	EMERALD
static final TrimMaterial	GOLD
static final TrimMaterial	IRON
static final TrimMaterial	LAPIS
static final TrimMaterial	NETHERITE
static final TrimMaterial	QUARTZ
static final TrimMaterial	REDSTONE
static final TrimMaterial	RESIN

Method Summary

Modifier and Type	Method	Description
static TrimMaterial	create(Consumer<RegistryBuilderFactory<TrimMaterial, ? extends TrimMaterialRegistryEntry.Builder>> value)	Creates an inlined trim material.
Component	description()	Get the description of this TrimMaterial.
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.
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 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

AMETHYST

static final TrimMaterial AMETHYST

COPPER

static final TrimMaterial COPPER

DIAMOND

static final TrimMaterial DIAMOND

EMERALD

static final TrimMaterial EMERALD

GOLD

static final TrimMaterial GOLD

IRON

static final TrimMaterial IRON

LAPIS

static final TrimMaterial LAPIS

NETHERITE

static final TrimMaterial NETHERITE

QUARTZ

static final TrimMaterial QUARTZ

REDSTONE

static final TrimMaterial REDSTONE

RESIN

static final TrimMaterial RESIN

Method Details

create

@Experimental
static TrimMaterial create(Consumer<RegistryBuilderFactory<TrimMaterial, ? extends TrimMaterialRegistryEntry.Builder>> value)

Creates an inlined trim material.

Parameters:

value - a consumer for the builder factory

Returns:

the created trim material

description

Component description()

Get the description of this TrimMaterial.

Returns:

the description

getTranslationKey

@Deprecated(forRemoval=true)
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")
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 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