Record Class FoodProperties

java.lang.Object

java.lang.Record

net.minecraft.world.food.FoodProperties

All Implemented Interfaces:

ConsumableListener

public record FoodProperties(int nutrition, float saturation, boolean canAlwaysEat)
extends Record
implements ConsumableListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FoodProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	canAlwaysEat	The field for the canAlwaysEat record component.
static final com.mojang.serialization.Codec<FoodProperties>	DIRECT_CODEC
static final StreamCodec<RegistryFriendlyByteBuf, FoodProperties>	DIRECT_STREAM_CODEC
private final int	nutrition	The field for the nutrition record component.
private final float	saturation	The field for the saturation record component.

Constructor Summary

Constructors

Constructor	Description
FoodProperties(int nutrition, float saturation, boolean canAlwaysEat)	Creates an instance of a FoodProperties record class.

Method Summary

Modifier and Type	Method	Description
boolean	canAlwaysEat()	Returns the value of the canAlwaysEat 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.
void	onConsume(Level level, LivingEntity user, ItemStack stack, Consumable consumable)
float	saturation()	Returns the value of the saturation record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

nutrition

private final int nutrition

The field for the nutrition record component.

saturation

private final float saturation

The field for the saturation record component.

canAlwaysEat

private final boolean canAlwaysEat

The field for the canAlwaysEat record component.

DIRECT_CODEC

public static final com.mojang.serialization.Codec<FoodProperties> DIRECT_CODEC

DIRECT_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, FoodProperties> DIRECT_STREAM_CODEC

Constructor Details

FoodProperties

public FoodProperties(int nutrition,
 float saturation,
 boolean canAlwaysEat)

Creates an instance of a FoodProperties record class.

Parameters:

nutrition - the value for the nutrition record component

saturation - the value for the saturation record component

canAlwaysEat - the value for the canAlwaysEat record component

Method Details

onConsume

public void onConsume(Level level,
 LivingEntity user,
 ItemStack stack,
 Consumable consumable)

Specified by:

onConsume in interface ConsumableListener

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 the compare method from their corresponding wrapper classes.

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

saturation

public float saturation()

Returns the value of the saturation record component.

Returns:

the value of the saturation record component

canAlwaysEat

public boolean canAlwaysEat()

Returns the value of the canAlwaysEat record component.

Returns:

the value of the canAlwaysEat record component