Record Class BiomeEffects

java.lang.Object

java.lang.Record

net.minestom.server.world.biome.BiomeEffects

public record BiomeEffects(RGBLike fogColor, RGBLike skyColor, RGBLike waterColor, RGBLike waterFogColor, @Nullable RGBLike foliageColor, @Nullable RGBLike grassColor, BiomeEffects.GrassColorModifier grassColorModifier, BiomeEffects.Particle biomeParticle, @Nullable SoundEvent ambientSound, BiomeEffects.MoodSound moodSound, BiomeEffects.AdditionsSound additionsSound, @Nullable List<BiomeEffects.WeightedMusic> music, @Nullable Float musicVolume)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BiomeEffects.AdditionsSound
static final class	BiomeEffects.Builder
static enum	BiomeEffects.GrassColorModifier
static final record	BiomeEffects.MoodSound
static final record	BiomeEffects.Particle
static final record	BiomeEffects.WeightedMusic

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor

Description

BiomeEffects(RGBLike fogColor, RGBLike skyColor, RGBLike waterColor, RGBLike waterFogColor, @Nullable RGBLike foliageColor, @Nullable RGBLike grassColor, BiomeEffects.GrassColorModifier grassColorModifier, BiomeEffects.Particle biomeParticle, @Nullable SoundEvent ambientSound, BiomeEffects.MoodSound moodSound, BiomeEffects.AdditionsSound additionsSound, @Nullable List<BiomeEffects.WeightedMusic> music, @Nullable Float musicVolume)

Creates an instance of a BiomeEffects record class.

Method Summary

Modifier and Type	Method	Description
BiomeEffects.AdditionsSound	additionsSound()	Returns the value of the additionsSound record component.
@Nullable SoundEvent	ambientSound()	Returns the value of the ambientSound record component.
BiomeEffects.Particle	biomeParticle()	Returns the value of the biomeParticle record component.
static BiomeEffects.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
RGBLike	fogColor()	Returns the value of the fogColor record component.
@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.
BiomeEffects.MoodSound	moodSound()	Returns the value of the moodSound record component.
@Nullable List<BiomeEffects.WeightedMusic>	music()	Returns the value of the music record component.
@Nullable Float	musicVolume()	Returns the value of the musicVolume record component.
RGBLike	skyColor()	Returns the value of the skyColor record component.
final String	toString()	Returns a string representation of this record class.
RGBLike	waterColor()	Returns the value of the waterColor record component.
RGBLike	waterFogColor()	Returns the value of the waterFogColor record component.

Methods inherited from class Object

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

Field Details

PLAINS_EFFECTS

public static final BiomeEffects PLAINS_EFFECTS

CODEC

public static final Codec<BiomeEffects> CODEC

Constructor Details

BiomeEffects

public BiomeEffects(RGBLike fogColor,
 RGBLike skyColor,
 RGBLike waterColor,
 RGBLike waterFogColor,
 @Nullable
 @Nullable RGBLike foliageColor,
 @Nullable
 @Nullable RGBLike grassColor,
 BiomeEffects.GrassColorModifier grassColorModifier,
 @Nullable
 BiomeEffects.Particle biomeParticle,
 @Nullable
 @Nullable SoundEvent ambientSound,
 @Nullable
 BiomeEffects.MoodSound moodSound,
 @Nullable
 BiomeEffects.AdditionsSound additionsSound,
 @Nullable
 @Nullable List<BiomeEffects.WeightedMusic> music,
 @Nullable
 @Nullable Float musicVolume)

Creates an instance of a BiomeEffects record class.

Parameters:

fogColor - the value for the fogColor record component

skyColor - the value for the skyColor record component

waterColor - the value for the waterColor record component

waterFogColor - the value for the waterFogColor record component

foliageColor - the value for the foliageColor record component

grassColor - the value for the grassColor record component

grassColorModifier - the value for the grassColorModifier record component

biomeParticle - the value for the biomeParticle record component

ambientSound - the value for the ambientSound record component

moodSound - the value for the moodSound record component

additionsSound - the value for the additionsSound record component

music - the value for the music record component

musicVolume - the value for the musicVolume 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.

fogColor

public RGBLike fogColor()

Returns the value of the fogColor record component.

Returns:

the value of the fogColor record component

skyColor

public RGBLike skyColor()

Returns the value of the skyColor record component.

Returns:

the value of the skyColor record component

waterColor

public RGBLike waterColor()

Returns the value of the waterColor record component.

Returns:

the value of the waterColor record component

waterFogColor

public RGBLike waterFogColor()

Returns the value of the waterFogColor record component.

Returns:

the value of the waterFogColor record component

foliageColor

@Nullable
public @Nullable RGBLike foliageColor()

Returns the value of the foliageColor record component.

Returns:

the value of the foliageColor 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

biomeParticle

@Nullable
public BiomeEffects.Particle biomeParticle()

Returns the value of the biomeParticle record component.

Returns:

the value of the biomeParticle record component

ambientSound

@Nullable
public @Nullable SoundEvent ambientSound()

Returns the value of the ambientSound record component.

Returns:

the value of the ambientSound record component

moodSound

@Nullable
public BiomeEffects.MoodSound moodSound()

Returns the value of the moodSound record component.

Returns:

the value of the moodSound record component

additionsSound

@Nullable
public BiomeEffects.AdditionsSound additionsSound()

Returns the value of the additionsSound record component.

Returns:

the value of the additionsSound record component

music

@Nullable
public @Nullable List<BiomeEffects.WeightedMusic> music()

Returns the value of the music record component.

Returns:

the value of the music record component

musicVolume

@Nullable
public @Nullable Float musicVolume()

Returns the value of the musicVolume record component.

Returns:

the value of the musicVolume record component