Package net.minestom.server.item.component

Record Class Food

java.lang.Object

java.lang.Record

net.minestom.server.item.component.Food

public record Food(int nutrition, float saturationModifier, boolean canAlwaysEat, float eatSeconds, @NotNull ItemStack usingConvertsTo, @NotNull List<Food.EffectChance> effects)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Food.EffectChance

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_EAT_SECONDS
static final BinaryTagSerializer<Food>	NBT_TYPE
static final NetworkBuffer.Type<Food>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
Food(int nutrition, float saturationModifier, boolean canAlwaysEat, float eatSeconds, @NotNull ItemStack usingConvertsTo, @NotNull List<Food.EffectChance> effects)	Creates an instance of a Food record class.

Method Summary

Modifier and Type	Method	Description
boolean	canAlwaysEat()	Returns the value of the canAlwaysEat record component.
int	eatDurationTicks()
float	eatSeconds()	Returns the value of the eatSeconds record component.
@NotNull List<Food.EffectChance>	effects()	Returns the value of the effects record component.
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.
int	nutrition()	Returns the value of the nutrition record component.
float	saturationModifier()	Returns the value of the saturationModifier record component.
final String	toString()	Returns a string representation of this record class.
@NotNull ItemStack	usingConvertsTo()	Returns the value of the usingConvertsTo record component.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EAT_SECONDS

public static final float DEFAULT_EAT_SECONDS

See Also:

• Constant Field Values

NETWORK_TYPE

public static final NetworkBuffer.Type<Food> NETWORK_TYPE

NBT_TYPE

public static final BinaryTagSerializer<Food> NBT_TYPE

Constructor Details

Food

public Food(int nutrition,
 float saturationModifier,
 boolean canAlwaysEat,
 float eatSeconds,
 @NotNull
 @NotNull ItemStack usingConvertsTo,
 @NotNull
 @NotNull List<Food.EffectChance> effects)

Creates an instance of a Food record class.

Parameters:

nutrition - the value for the nutrition record component

saturationModifier - the value for the saturationModifier record component

canAlwaysEat - the value for the canAlwaysEat record component

eatSeconds - the value for the eatSeconds record component

usingConvertsTo - the value for the usingConvertsTo record component

effects - the value for the effects record component

Method Details

eatDurationTicks

public int eatDurationTicks()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

nutrition

public int nutrition()

Returns the value of the nutrition record component.

Returns:

the value of the nutrition record component

saturationModifier

public float saturationModifier()

Returns the value of the saturationModifier record component.

Returns:

the value of the saturationModifier record component

canAlwaysEat

public boolean canAlwaysEat()

Returns the value of the canAlwaysEat record component.

Returns:

the value of the canAlwaysEat record component

eatSeconds

public float eatSeconds()

Returns the value of the eatSeconds record component.

Returns:

the value of the eatSeconds record component

usingConvertsTo

@NotNull
public @NotNull ItemStack usingConvertsTo()

Returns the value of the usingConvertsTo record component.

Returns:

the value of the usingConvertsTo record component

effects

@NotNull
public @NotNull List<Food.EffectChance> effects()

Returns the value of the effects record component.

Returns:

the value of the effects record component