Package net.darkhax.botanypots.common.api.data

Record Class SoundEffect

java.lang.Object
java.lang.Record
net.darkhax.botanypots.common.api.data.SoundEffect
public record SoundEffect(net.minecraft.core.Holder<net.minecraft.sounds.SoundEvent> sound, net.minecraft.sounds.SoundSource source, float volume, float pitch) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<SoundEffect>
    CODEC
     
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,Optional<SoundEffect>>
    OPTIONAL_STREAM
     
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,SoundEffect>
    STREAM
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SoundEffect(net.minecraft.core.Holder<net.minecraft.sounds.SoundEvent> sound, net.minecraft.sounds.SoundSource source, float volume, float pitch)
    Creates an instance of a SoundEffect record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    float
    pitch()
    Returns the value of the pitch record component.
    void
    playSound(net.minecraft.server.level.ServerLevel level, net.minecraft.world.entity.player.Player player, float x, float y, float z)
     
    void
    playSound(net.minecraft.server.level.ServerLevel level, net.minecraft.world.entity.player.Player player, net.minecraft.core.BlockPos pos)
     
    net.minecraft.core.Holder<net.minecraft.sounds.SoundEvent>
    sound()
    Returns the value of the sound record component.
    net.minecraft.sounds.SoundSource
    source()
    Returns the value of the source record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    volume()
    Returns the value of the volume record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • CODEC

      public static final com.mojang.serialization.MapCodec<SoundEffect> CODEC

    • STREAM

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,SoundEffect> STREAM

    • OPTIONAL_STREAM

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,Optional<SoundEffect>> OPTIONAL_STREAM

  • Constructor Details

    • SoundEffect

      public SoundEffect(net.minecraft.core.Holder<net.minecraft.sounds.SoundEvent> sound, net.minecraft.sounds.SoundSource source, float volume, float pitch)
      Creates an instance of a SoundEffect record class.
      Parameters:
      sound - the value for the sound record component
      source - the value for the source record component
      volume - the value for the volume record component
      pitch - the value for the pitch record component

  • Method Details

    • playSound

      public void playSound(net.minecraft.server.level.ServerLevel level, net.minecraft.world.entity.player.Player player, net.minecraft.core.BlockPos pos)

    • playSound

      public void playSound(net.minecraft.server.level.ServerLevel level, net.minecraft.world.entity.player.Player player, float x, float y, float z)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • sound

      public net.minecraft.core.Holder<net.minecraft.sounds.SoundEvent> sound()
      Returns the value of the sound record component.
      Returns:
      the value of the sound record component

    • source

      public net.minecraft.sounds.SoundSource source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • volume

      public float volume()
      Returns the value of the volume record component.
      Returns:
      the value of the volume record component

    • pitch

      public float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component