Package net.neoforged.neoforge.event

Class PlayLevelSoundEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.PlayLevelSoundEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Direct Known Subclasses:

PlayLevelSoundEvent.AtEntity, PlayLevelSoundEvent.AtPosition

public class PlayLevelSoundEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

PlayLevelSoundEvent is fired when a sound is played on a Level. This event is fired from Level.playSound(net.minecraft.world.entity.Entity, 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.core.Holder<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 NeoForge.EVENT_BUS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlayLevelSoundEvent.AtEntity	PlayLevelSoundEvent.AtEntity is fired when a sound is played on the Level at an Entity's position.
static class	PlayLevelSoundEvent.AtPosition	PlayLevelSoundEvent.AtPosition is fired when a sound is played on the Level at a specific position.

Field Summary

Fields

Modifier and Type	Field	Description
private final Level	level
private float	newPitch
private float	newVolume
private final float	originalPitch
private final float	originalVolume
private Holder<SoundEvent>	sound
private SoundSource	source

Constructor Summary

Constructors

Constructor	Description
PlayLevelSoundEvent(Level level, Holder<SoundEvent> sound, SoundSource source, float volume, float pitch)

Method Summary

Modifier and Type	Method	Description
Level	getLevel()	Returns the level the sound is being played in.
float	getNewPitch()	Returns the pitch the sound will be played at.
float	getNewVolume()	Returns the volume the sound will be played at.
float	getOriginalPitch()	Returns the original pitch for the sound to be played at.
float	getOriginalVolume()	Returns the original volume for the sound to be played at.
@Nullable Holder<SoundEvent>	getSound()	Returns the sound event to be played.
SoundSource	getSource()	Returns the sound source.
void	setNewPitch(float newPitch)	Sets the pitch the sound will be played at.
void	setNewVolume(float newVolume)	Sets the volume the sound will be played at.
void	setSound(@Nullable Holder<SoundEvent> sound)	Sets the sound event to be played.
void	setSource(SoundSource source)	Sets the sound source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

level

private final Level level

originalVolume

private final float originalVolume

originalPitch

private final float originalPitch

sound

private Holder<SoundEvent> sound

source

private SoundSource source

newVolume

private float newVolume

newPitch

private float newPitch

Constructor Details

PlayLevelSoundEvent

public PlayLevelSoundEvent(Level level,
 Holder<SoundEvent> sound,
 SoundSource source,
 float volume,
 float pitch)

Method Details

getLevel

public Level getLevel()

Returns the level the sound is being played in.

Returns:

the level the sound is being played in

getSound

@Nullable
public @Nullable Holder<SoundEvent> getSound()

Returns the sound event to be played.

Returns:

the sound event to be played

setSound

public void setSound(@Nullable
 @Nullable Holder<SoundEvent> sound)

Sets the sound event to be played.

getSource

public SoundSource getSource()

Returns the sound source.

Returns:

the sound source

setSource

public void setSource(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.