Package net.ixdarklord.coolcatcanvas.api.client.sound

Interface SoundFilterProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SoundFilterProvider

Says how a sound comes through to the listener; registered with SoundFilters.register(net.ixdarklord.coolcatcanvas.api.client.sound.SoundFilterProvider). It is asked about every sound the game plays, music and the menus included (SoundContext.relative()), as it starts and as it moves. It is asked on the sound thread, so it must be quick and read only state that is safe to read from there (an immutable snapshot the game thread swaps in, for example).

 SoundFilters.register(sound -> sound.source() == SoundSource.HOSTILE ? SoundFilter.muffled(0.5F) : SoundFilter.NONE);
 SoundFilters.register(SoundFilterProvider.inWorld(position -> walls.filter(position)));
 

Method Summary

Modifier and Type	Method	Description
SoundFilter	filter(SoundContext sound)	The filter for this sound, or SoundFilter.NONE to leave it be.
static SoundFilterProvider	inWorld(Function<net.minecraft.world.phys.Vec3,SoundFilter> filter)	A provider for the sounds at a place in the world only, by their place; music and the menus are left be.

Method Details

filter

SoundFilter filter(SoundContext sound)

The filter for this sound, or SoundFilter.NONE to leave it be.

inWorld

static SoundFilterProvider inWorld(Function<net.minecraft.world.phys.Vec3,SoundFilter> filter)

A provider for the sounds at a place in the world only, by their place; music and the menus are left be.