Record Class ItemLore

java.lang.Object

java.lang.Record

net.minecraft.world.item.component.ItemLore

All Implemented Interfaces:

TooltipProvider

public record ItemLore(List<Component> lines, List<Component> styledLines)
extends Record
implements TooltipProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<ItemLore>	CODEC
static final ItemLore	EMPTY
private final List<Component>	lines	The field for the lines record component.
private static final Style	LORE_STYLE
static final int	MAX_LINES
static final StreamCodec<RegistryFriendlyByteBuf, ItemLore>	STREAM_CODEC
private final List<Component>	styledLines	The field for the styledLines record component.

Constructor Summary

Constructors

Constructor	Description
ItemLore(List<Component> lines)
ItemLore(List<Component> lines, List<Component> styledLines)	Creates an instance of a ItemLore record class.

Method Summary

Modifier and Type	Method	Description
void	addToTooltip(Item.TooltipContext context, Consumer<Component> consumer, TooltipFlag flag, DataComponentGetter components)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<Component>	lines()	Returns the value of the lines record component.
List<Component>	styledLines()	Returns the value of the styledLines record component.
final String	toString()	Returns a string representation of this record class.
ItemLore	withLineAdded(Component component)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

lines

private final List<Component> lines

The field for the lines record component.

styledLines

private final List<Component> styledLines

The field for the styledLines record component.

EMPTY

public static final ItemLore EMPTY

MAX_LINES

public static final int MAX_LINES

See Also:

• Constant Field Values

LORE_STYLE

private static final Style LORE_STYLE

CODEC

public static final com.mojang.serialization.Codec<ItemLore> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, ItemLore> STREAM_CODEC

Constructor Details

ItemLore

public ItemLore(List<Component> lines)

ItemLore

public ItemLore(List<Component> lines,
 List<Component> styledLines)

Creates an instance of a ItemLore record class.

Parameters:

lines - the value for the lines record component

styledLines - the value for the styledLines record component

Method Details

withLineAdded

public ItemLore withLineAdded(Component component)

addToTooltip

public void addToTooltip(Item.TooltipContext context,
 Consumer<Component> consumer,
 TooltipFlag flag,
 DataComponentGetter components)

Specified by:

addToTooltip in interface TooltipProvider

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

lines

public List<Component> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

styledLines

public List<Component> styledLines()

Returns the value of the styledLines record component.

Returns:

the value of the styledLines record component