Package net.frozenblock.lib.gravity.api.functions

Record Class AbsoluteGravityFunction

java.lang.Object

java.lang.Record

net.frozenblock.lib.gravity.api.functions.AbsoluteGravityFunction

All Implemented Interfaces:

GravityFunction, SerializableGravityFunction<AbsoluteGravityFunction>

public record AbsoluteGravityFunction(double gravity)
extends Record
implements SerializableGravityFunction<AbsoluteGravityFunction>

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<GravityBelt<AbsoluteGravityFunction>>	BELT_CODEC
static final com.mojang.serialization.Codec<AbsoluteGravityFunction>	CODEC

Constructor Summary

Constructors

Constructor	Description
AbsoluteGravityFunction(double gravity)	Creates an instance of a AbsoluteGravityFunction record class.

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.Codec<AbsoluteGravityFunction>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
double	get(@Nullable net.minecraft.world.entity.Entity entity, double y, double minY, double maxY)
double	gravity()	Returns the value of the gravity record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

CODEC

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

BELT_CODEC

public static final com.mojang.serialization.Codec<GravityBelt<AbsoluteGravityFunction>> BELT_CODEC

Constructor Details

AbsoluteGravityFunction

public AbsoluteGravityFunction(double gravity)

Creates an instance of a AbsoluteGravityFunction record class.

Parameters:

gravity - the value for the gravity record component

Method Details

get

public double get(@Nullable
 @Nullable net.minecraft.world.entity.Entity entity,
 double y,
 double minY,
 double maxY)

Specified by:

get in interface GravityFunction

Parameters:

entity - The optional entity being tracked

y - The current y position

minY - The minimum Y position of the gravity belt

maxY - The maximum Y position of the gravity belt

Returns:

The gravity value

codec

public com.mojang.serialization.Codec<AbsoluteGravityFunction> codec()

Specified by:

codec in interface SerializableGravityFunction<AbsoluteGravityFunction>

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 '=='.

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.

gravity

public double gravity()

Returns the value of the gravity record component.

Returns:

the value of the gravity record component