Class PlayLevelSoundEvent.AtEntity

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.PlayLevelSoundEvent

net.neoforged.neoforge.event.PlayLevelSoundEvent.AtEntity

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

PlayLevelSoundEvent

public static class PlayLevelSoundEvent.AtEntity
extends PlayLevelSoundEvent

PlayLevelSoundEvent.AtEntity is fired when a sound is played on the Level at an Entity's position. This event is fired from Level.playSound(Entity, BlockPos, SoundEvent, SoundSource, float, float), Level.playSeededSound(Entity, double, double, double, Holder, SoundSource, float, float, long), and

invalid reference

LocalPlayer#playSound

.

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/interfaces inherited from class PlayLevelSoundEvent

PlayLevelSoundEvent.AtEntity, PlayLevelSoundEvent.AtPosition

Field Summary

Fields

Modifier and Type	Field	Description
private final Entity	entity

Constructor Summary

Constructors

Constructor	Description
AtEntity(Entity entity, Holder<SoundEvent> sound, SoundSource source, float volume, float pitch)

Method Summary

Modifier and Type	Method	Description
Entity	getEntity()	Returns the entity the sound is being played on.

Methods inherited from class PlayLevelSoundEvent

getLevel, getNewPitch, getNewVolume, getOriginalPitch, getOriginalVolume, getSound, getSource, setNewPitch, setNewVolume, setSound, setSource

Methods inherited from class 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

entity

private final Entity entity

Constructor Details

AtEntity

public AtEntity(Entity entity,
 Holder<SoundEvent> sound,
 SoundSource source,
 float volume,
 float pitch)

Method Details

getEntity

public Entity getEntity()

Returns the entity the sound is being played on.

Returns:

the entity the sound is being played on