Package net.neoforged.neoforge.client.event.sound

Class SoundEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.sound.SoundEvent
Direct Known Subclasses:
PlaySoundEvent, SoundEngineLoadEvent, SoundEvent.SoundSourceEvent
public abstract class SoundEvent extends net.neoforged.bus.api.Event
Superclass for sound related events.

These events are fired on the main Forge event bus, only on the logical client.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    SoundEvent.SoundSourceEvent
    Superclass for when a sound has started to play on an audio channel.

    Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

    net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final SoundEngine
    engine
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SoundEvent(SoundEngine engine)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    SoundEngine
    getEngine()
    Returns the sound engine.

    Methods inherited from class net.neoforged.bus.api.Event

    getResult, hasResult, setResult

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • SoundEvent

      @Internal protected SoundEvent(SoundEngine engine)

  • Method Details

    • getEngine

      public SoundEngine getEngine()
      Returns the sound engine.
      Returns:
      the sound engine