Interface TrimPattern

All Superinterfaces:

Keyed, Keyed, Translatable

@NullMarked
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
static final TrimPattern	COAST
static final TrimPattern	DUNE
static final TrimPattern	EYE
static final TrimPattern	FLOW
static final TrimPattern	HOST
static final TrimPattern	RAISER
static final TrimPattern	RIB
static final TrimPattern	SENTRY
static final TrimPattern	SHAPER
static final TrimPattern	SILENCE
static final TrimPattern	SNOUT
static final TrimPattern	SPIRE
static final TrimPattern	TIDE
static final TrimPattern	VEX
static final TrimPattern	WARD
static final TrimPattern	WAYFINDER
static final TrimPattern	WILD

Method Summary

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

Field Details

BOLT

static final TrimPattern BOLT

COAST

static final TrimPattern COAST

DUNE

static final TrimPattern DUNE

EYE

static final TrimPattern EYE

FLOW

static final TrimPattern FLOW

HOST

static final TrimPattern HOST

RAISER

static final TrimPattern RAISER

RIB

static final TrimPattern RIB

SENTRY

static final TrimPattern SENTRY

SHAPER

static final TrimPattern SHAPER

SILENCE

static final TrimPattern SILENCE

SNOUT

static final TrimPattern SNOUT

SPIRE

static final TrimPattern SPIRE

TIDE

static final TrimPattern TIDE

VEX

static final TrimPattern VEX

WARD

static final TrimPattern WARD

WAYFINDER

static final TrimPattern WAYFINDER

WILD

static final TrimPattern WILD

Method Details

create

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

Creates an inlined trim pattern.

Parameters:

value - a consumer for the builder factory

Returns:

the created trim pattern

description

Component description()

Get the description of this TrimPattern.

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_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 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