Class SoundDefinitionProviderBase

java.lang.Object

org.moddingx.libx.datagen.provider.SoundDefinitionProviderBase

All Implemented Interfaces:

net.minecraft.data.DataProvider

public abstract class SoundDefinitionProviderBase
extends Object
implements net.minecraft.data.DataProvider

A base class for sound definition providers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SoundDefinitionProviderBase.SoundDefinitionBuilder	A builder for a sound definition.
protected static class	SoundDefinitionProviderBase.SoundSettingsBuilder

Nested classes/interfaces inherited from interface net.minecraft.data.DataProvider

net.minecraft.data.DataProvider.Factory<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final ModX	mod

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, INDENT_WIDTH, KEY_COMPARATOR, LOGGER

Constructor Summary

Constructors

Constructor	Description
SoundDefinitionProviderBase(DatagenContext ctx)

Method Summary

Modifier and Type	Method	Description
protected void	defaultSound(net.minecraft.resources.Identifier id, net.minecraft.sounds.SoundEvent sound)	Default behavior for sound events.
String	getName()
protected void	ignore(net.minecraft.resources.Identifier sound)	This sound will not be processed by the default generator
protected void	ignore(net.minecraft.sounds.SoundEvent sound)	This sound will not be processed by the default generator
CompletableFuture<?>	run(net.minecraft.data.CachedOutput cache)
protected SoundDefinitionProviderBase.SoundSettingsBuilder	settings()	Creates some empty sound settings
protected abstract void	setup()
protected SoundDefinitionProviderBase.SoundDefinitionBuilder	sound(net.minecraft.resources.Identifier sound)	Creates a new sound definition for the given sound event.
protected SoundDefinitionProviderBase.SoundDefinitionBuilder	sound(net.minecraft.resources.Identifier sound, SoundDefinitionProviderBase.SoundSettingsBuilder settings)	Creates a new sound definition for the given sound event and default sound settings.
protected SoundDefinitionProviderBase.SoundDefinitionBuilder	sound(net.minecraft.sounds.SoundEvent sound)	Creates a new sound definition for the given sound event.
protected SoundDefinitionProviderBase.SoundDefinitionBuilder	sound(net.minecraft.sounds.SoundEvent sound, SoundDefinitionProviderBase.SoundSettingsBuilder settings)	Creates a new sound definition for the given sound event and default sound settings.

Methods inherited from class Object

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

Field Details

mod

protected final ModX mod

Constructor Details

SoundDefinitionProviderBase

public SoundDefinitionProviderBase(DatagenContext ctx)

Method Details

getName

@Nonnull
public String getName()

Specified by:

getName in interface net.minecraft.data.DataProvider

ignore

protected void ignore(net.minecraft.sounds.SoundEvent sound)

This sound will not be processed by the default generator

ignore

protected void ignore(net.minecraft.resources.Identifier sound)

This sound will not be processed by the default generator

setup

protected abstract void setup()

defaultSound

protected void defaultSound(net.minecraft.resources.Identifier id,
 net.minecraft.sounds.SoundEvent sound)

Default behavior for sound events. Override to change.

settings

protected SoundDefinitionProviderBase.SoundSettingsBuilder settings()

Creates some empty sound settings

sound

protected SoundDefinitionProviderBase.SoundDefinitionBuilder sound(net.minecraft.sounds.SoundEvent sound)

Creates a new sound definition for the given sound event.

sound

protected SoundDefinitionProviderBase.SoundDefinitionBuilder sound(net.minecraft.resources.Identifier sound)

Creates a new sound definition for the given sound event.

sound

protected SoundDefinitionProviderBase.SoundDefinitionBuilder sound(net.minecraft.sounds.SoundEvent sound,
 SoundDefinitionProviderBase.SoundSettingsBuilder settings)

Creates a new sound definition for the given sound event and default sound settings.

sound

protected SoundDefinitionProviderBase.SoundDefinitionBuilder sound(net.minecraft.resources.Identifier sound,
 SoundDefinitionProviderBase.SoundSettingsBuilder settings)

Creates a new sound definition for the given sound event and default sound settings.

run

@Nonnull
public CompletableFuture<?> run(@Nonnull
 net.minecraft.data.CachedOutput cache)

Specified by:

run in interface net.minecraft.data.DataProvider