Record Class BiomeEffects

java.lang.Object

java.lang.Record

net.minestom.server.world.biome.BiomeEffects

public record BiomeEffects(RGBLike waterColor, @Nullable RGBLike foliageColor, @Nullable RGBLike dryFoliageColor, @Nullable RGBLike grassColor, BiomeEffects.GrassColorModifier grassColorModifier)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BiomeEffects.Builder
static enum	BiomeEffects.GrassColorModifier

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<BiomeEffects>	CODEC
static final BiomeEffects	DEFAULT

Constructor Summary

Constructors

Constructor	Description
BiomeEffects(RGBLike waterColor, @Nullable RGBLike foliageColor, @Nullable RGBLike dryFoliageColor, @Nullable RGBLike grassColor, BiomeEffects.GrassColorModifier grassColorModifier)	Creates an instance of a BiomeEffects record class.

Method Summary

Modifier and Type	Method	Description
static BiomeEffects.Builder	builder()
@Nullable RGBLike	dryFoliageColor()	Returns the value of the dryFoliageColor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable RGBLike	foliageColor()	Returns the value of the foliageColor record component.
@Nullable RGBLike	grassColor()	Returns the value of the grassColor record component.
BiomeEffects.GrassColorModifier	grassColorModifier()	Returns the value of the grassColorModifier record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
RGBLike	waterColor()	Returns the value of the waterColor record component.

Methods inherited from class Object

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

Field Details

DEFAULT

public static final BiomeEffects DEFAULT

CODEC

public static final Codec<BiomeEffects> CODEC

Constructor Details

BiomeEffects

public BiomeEffects(RGBLike waterColor,
 @Nullable
 @Nullable RGBLike foliageColor,
 @Nullable
 @Nullable RGBLike dryFoliageColor,
 @Nullable
 @Nullable RGBLike grassColor,
 BiomeEffects.GrassColorModifier grassColorModifier)

Creates an instance of a BiomeEffects record class.

Parameters:

waterColor - the value for the waterColor record component

foliageColor - the value for the foliageColor record component

dryFoliageColor - the value for the dryFoliageColor record component

grassColor - the value for the grassColor record component

grassColorModifier - the value for the grassColorModifier record component

Method Details

builder

public static BiomeEffects.Builder builder()

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.

waterColor

public RGBLike waterColor()

Returns the value of the waterColor record component.

Returns:

the value of the waterColor record component

foliageColor

@Nullable
public @Nullable RGBLike foliageColor()

Returns the value of the foliageColor record component.

Returns:

the value of the foliageColor record component

dryFoliageColor

@Nullable
public @Nullable RGBLike dryFoliageColor()

Returns the value of the dryFoliageColor record component.

Returns:

the value of the dryFoliageColor record component

grassColor

@Nullable
public @Nullable RGBLike grassColor()

Returns the value of the grassColor record component.

Returns:

the value of the grassColor record component

grassColorModifier

public BiomeEffects.GrassColorModifier grassColorModifier()

Returns the value of the grassColorModifier record component.

Returns:

the value of the grassColorModifier record component