Package net.minestom.server.world.biome

Record Class BiomeEffects

java.lang.Object
java.lang.Record
net.minestom.server.world.biome.BiomeEffects
public record BiomeEffects(@NotNull RGBLike fogColor, @NotNull RGBLike skyColor, @NotNull RGBLike waterColor, @NotNull RGBLike waterFogColor, @Nullable RGBLike foliageColor, @Nullable RGBLike grassColor, @NotNull 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

  • Field Details

  • Constructor Details

    • BiomeEffects

      public BiomeEffects(@NotNull @NotNull RGBLike fogColor, @NotNull @NotNull RGBLike skyColor, @NotNull @NotNull RGBLike waterColor, @NotNull @NotNull RGBLike waterFogColor, @Nullable @Nullable RGBLike foliageColor, @Nullable @Nullable RGBLike grassColor, @NotNull @NotNull 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

      @NotNull public @NotNull RGBLike fogColor()
      Returns the value of the fogColor record component.
      Returns:
      the value of the fogColor record component

    • skyColor

      @NotNull public @NotNull RGBLike skyColor()
      Returns the value of the skyColor record component.
      Returns:
      the value of the skyColor record component

    • waterColor

      @NotNull public @NotNull RGBLike waterColor()
      Returns the value of the waterColor record component.
      Returns:
      the value of the waterColor record component

    • waterFogColor

      @NotNull public @NotNull 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

      @NotNull public @NotNull 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