Package org.bukkit.inventory.meta.trim

Interface TrimPattern

All Superinterfaces:

Keyed, Keyed, Translatable

public interface TrimPattern
extends Keyed, Translatable

Represents a pattern that may be used in an ArmorTrim.

Field Summary

Fields

Modifier and Type	Field	Description
static final TrimPattern	BOLT	Material.BOLT_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	COAST	Material.COAST_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	DUNE	Material.DUNE_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	EYE	Material.EYE_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	FLOW	Material.FLOW_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	HOST	Material.HOST_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	RAISER	Material.RAISER_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	RIB	Material.RIB_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	SENTRY	Material.SENTRY_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	SHAPER	Material.SHAPER_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	SILENCE	Material.SILENCE_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	SNOUT	Material.SNOUT_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	SPIRE	Material.SPIRE_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	TIDE	Material.TIDE_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	VEX	Material.VEX_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	WARD	Material.WARD_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	WAYFINDER	Material.WAYFINDER_ARMOR_TRIM_SMITHING_TEMPLATE.
static final TrimPattern	WILD	Material.WILD_ARMOR_TRIM_SMITHING_TEMPLATE.

Method Summary

Modifier and Type	Method	Description
@NotNull Component	description()	Get the description of this TrimPattern.
@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_PATTERN.
@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_PATTERN.

Field Details

SENTRY

static final TrimPattern SENTRY

Material.SENTRY_ARMOR_TRIM_SMITHING_TEMPLATE.

DUNE

static final TrimPattern DUNE

Material.DUNE_ARMOR_TRIM_SMITHING_TEMPLATE.

COAST

static final TrimPattern COAST

Material.COAST_ARMOR_TRIM_SMITHING_TEMPLATE.

WILD

static final TrimPattern WILD

Material.WILD_ARMOR_TRIM_SMITHING_TEMPLATE.

WARD

static final TrimPattern WARD

Material.WARD_ARMOR_TRIM_SMITHING_TEMPLATE.

EYE

static final TrimPattern EYE

Material.EYE_ARMOR_TRIM_SMITHING_TEMPLATE.

VEX

static final TrimPattern VEX

Material.VEX_ARMOR_TRIM_SMITHING_TEMPLATE.

TIDE

static final TrimPattern TIDE

Material.TIDE_ARMOR_TRIM_SMITHING_TEMPLATE.

SNOUT

static final TrimPattern SNOUT

Material.SNOUT_ARMOR_TRIM_SMITHING_TEMPLATE.

RIB

static final TrimPattern RIB

Material.RIB_ARMOR_TRIM_SMITHING_TEMPLATE.

SPIRE

static final TrimPattern SPIRE

Material.SPIRE_ARMOR_TRIM_SMITHING_TEMPLATE.

WAYFINDER

static final TrimPattern WAYFINDER

Material.WAYFINDER_ARMOR_TRIM_SMITHING_TEMPLATE.

SHAPER

static final TrimPattern SHAPER

Material.SHAPER_ARMOR_TRIM_SMITHING_TEMPLATE.

SILENCE

static final TrimPattern SILENCE

Material.SILENCE_ARMOR_TRIM_SMITHING_TEMPLATE.

RAISER

static final TrimPattern RAISER

Material.RAISER_ARMOR_TRIM_SMITHING_TEMPLATE.

HOST

static final TrimPattern HOST

Material.HOST_ARMOR_TRIM_SMITHING_TEMPLATE.

FLOW

static final TrimPattern FLOW

Material.FLOW_ARMOR_TRIM_SMITHING_TEMPLATE.

BOLT

static final TrimPattern BOLT

Material.BOLT_ARMOR_TRIM_SMITHING_TEMPLATE.

Method Details

description

@NotNull Component description()

Get the description of this TrimPattern.

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_PATTERN. TrimPatterns 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_PATTERN. TrimPatterns 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