Package net.minecraftforge.event

Class PlayLevelSoundEvent

java.lang.Object
net.minecraftforge.eventbus.api.Event
net.minecraftforge.event.PlayLevelSoundEvent
Direct Known Subclasses:
PlayLevelSoundEvent.AtEntity, PlayLevelSoundEvent.AtPosition
public class PlayLevelSoundEvent extends net.minecraftforge.eventbus.api.Event
PlayLevelSoundEvent is fired when a sound is played on a Level. This event is fired from Level.playSound(net.minecraft.world.entity.player.Player, net.minecraft.core.BlockPos, net.minecraft.sounds.SoundEvent, net.minecraft.sounds.SoundSource, float, float), Level.playSeededSound(net.minecraft.world.entity.player.Player, double, double, double, net.minecraft.sounds.SoundEvent, net.minecraft.sounds.SoundSource, float, float, long), and LocalPlayer.playSound(net.minecraft.sounds.SoundEvent, float, float).

getLevel() contains the level the sound is being played in. getSound() contains the sound event to be played. getOriginalVolume() contains the original volume for the sound to be played at. getOriginalPitch() contains the original pitch for the sound to be played at. getNewVolume() contains the volume the sound will be played at. getNewPitch() contains the pitch the sound will be played at.

This event is cancelable. If this event is canceled, the sound is not played.

This event does not have a result.

This event is fired on the MinecraftForge.EVENT_BUS.

  • Field Details

    • level

      private final Level level

    • originalVolume

      private final float originalVolume

    • originalPitch

      private final float originalPitch

    • sound

      private SoundEvent sound

    • source

      private SoundSource source

    • newVolume

      private float newVolume

    • newPitch

      private float newPitch

  • Constructor Details

    • PlayLevelSoundEvent

      public PlayLevelSoundEvent(@NotNull @NotNull Level level, @NotNull @NotNull SoundEvent sound, @NotNull @NotNull SoundSource source, float volume, float pitch)

  • Method Details

    • getLevel

      @NotNull public @NotNull Level getLevel()
      Returns the level the sound is being played in.
      Returns:
      the level the sound is being played in

    • getSound

      @Nullable public @Nullable SoundEvent getSound()
      Returns the sound event to be played.
      Returns:
      the sound event to be played

    • setSound

      public void setSound(@Nullable @Nullable SoundEvent sound)
      Sets the sound event to be played.

    • getSource

      @NotNull public @NotNull SoundSource getSource()
      Returns the sound source.
      Returns:
      the sound source

    • setSource

      public void setSource(@NotNull @NotNull SoundSource source)
      Sets the sound source.

    • getOriginalVolume

      public float getOriginalVolume()
      Returns the original volume for the sound to be played at.
      Returns:
      the original volume for the sound to be played at

    • getOriginalPitch

      public float getOriginalPitch()
      Returns the original pitch for the sound to be played at.
      Returns:
      the original pitch for the sound to be played at

    • getNewVolume

      public float getNewVolume()
      Returns the volume the sound will be played at.
      Returns:
      the volume the sound will be played at

    • setNewVolume

      public void setNewVolume(float newVolume)
      Sets the volume the sound will be played at.

    • getNewPitch

      public float getNewPitch()
      Returns the pitch the sound will be played at.
      Returns:
      the pitch the sound will be played at

    • setNewPitch

      public void setNewPitch(float newPitch)
      Sets the pitch the sound will be played at.