net.minecraftforge.client.event.sound

Class PlayBackgroundMusicEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.client.event.sound.SoundEvent

net.minecraftforge.client.event.sound.SoundResultEvent

net.minecraftforge.client.event.sound.PlayBackgroundMusicEvent

Deprecated.

@Deprecated
public class PlayBackgroundMusicEvent
extends SoundResultEvent

Raised when the SoundManager tries to play a Background Music file, If you return null from this function it will prevent the sound from being played, you can return a different entry if you want to change the sound being played.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.client.event.sound.SoundEvent

SoundEvent.SoundSourceEvent

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields inherited from class net.minecraftforge.client.event.sound.SoundResultEvent

manager, name, pitch, result, source, volume

Constructor Summary

Constructors

Constructor and Description
PlayBackgroundMusicEvent(SoundManager manager, SoundPoolEntry entry) Deprecated.

Method Summary

Methods inherited from class net.minecraftforge.client.event.sound.SoundEvent

getResult

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayBackgroundMusicEvent

public PlayBackgroundMusicEvent(SoundManager manager,
                                SoundPoolEntry entry)

Deprecated.