Package io.papermc.paper.datacomponent.item.attribute

Interface AttributeModifierDisplay

All Known Subinterfaces:

AttributeModifierDisplay.Default, AttributeModifierDisplay.Hidden, AttributeModifierDisplay.OverrideText

@NullMarked
@Experimental
@NonExtendable
public interface AttributeModifierDisplay

The display behavior for a dedicated attribute entry.

See Also:

• DataComponentTypes.ATTRIBUTE_MODIFIERS
• ItemAttributeModifiers.itemAttributes()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AttributeModifierDisplay.Default	Default display for the attribute modifier, showing the statistic of its effect.
static interface	AttributeModifierDisplay.Hidden	Hidden statistics display for the attribute modifier.
static interface	AttributeModifierDisplay.OverrideText	Specifies an overridden text to show instead of the default behavior for the attribute modifier.

Method Summary

Static Methods

Modifier and Type	Method	Description
static AttributeModifierDisplay.Hidden	hidden()	Hides the statistics displayed by the attribute modifier.
static AttributeModifierDisplay.OverrideText	override(ComponentLike text)	Override the statistics displayed by the attribute modifier to an arbitrary text.
static AttributeModifierDisplay.Default	reset()	Reset any override of the text displayed by the attribute modifier to its default behavior displaying the statistics.

Method Details

reset

@Contract(value="-> new",
          pure=true)
static AttributeModifierDisplay.Default reset()

Reset any override of the text displayed by the attribute modifier to its default behavior displaying the statistics.

Returns:

the new display behavior instance

hidden

@Contract(value="-> new",
          pure=true)
static AttributeModifierDisplay.Hidden hidden()

Hides the statistics displayed by the attribute modifier.

Returns:

the new display behavior instance

override

@Contract(value="_ -> new",
          pure=true)
static AttributeModifierDisplay.OverrideText override(ComponentLike text)

Override the statistics displayed by the attribute modifier to an arbitrary text.

Parameters:

text - the overridden text

Returns:

the new display behavior instance