Package net.neoforged.neoforge.common.data

Class SoundDefinitionsProvider

java.lang.Object

net.neoforged.neoforge.common.data.SoundDefinitionsProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

DataGeneratorTest.SoundDefinitions, VanillaSoundDefinitionsProvider

public abstract class SoundDefinitionsProvider
extends Object
implements DataProvider

Data provider for the sounds.json file, which identifies sound definitions for the various sound events in Minecraft.

Nested Class Summary

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

DataProvider.Factory<T extends DataProvider>

Field Summary

Fields

Modifier and Type	Field	Description
private final ExistingFileHelper	helper
private static final org.apache.logging.log4j.Logger	LOGGER
private final String	modId
private final PackOutput	output
private final Map<String,SoundDefinition>	sounds

Fields inherited from interface net.minecraft.data.DataProvider

FIXED_ORDER_FIELDS, KEY_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SoundDefinitionsProvider(PackOutput output, String modId, ExistingFileHelper helper)	Creates a new instance of this data provider.

Method Summary

Modifier and Type	Method	Description
protected void	add(String soundEvent, SoundDefinition definition)	Adds the SoundEvent with the specified name along with its SoundDefinition to the list.
protected void	add(Supplier<SoundEvent> soundEvent, SoundDefinition definition)	Adds the entry name associated with the supplied SoundEvent with the given SoundDefinition to the list.
protected void	add(ResourceLocation soundEvent, SoundDefinition definition)	Adds the SoundEvent referenced by the given ResourceLocation with the SoundDefinition to the list.
protected void	add(SoundEvent soundEvent, SoundDefinition definition)	Adds the entry name associated with the given SoundEvent with the SoundDefinition to the list.
private void	addSounds(String soundEvent, SoundDefinition definition)
protected static SoundDefinition	definition()	Creates a new SoundDefinition, which will host a set of SoundDefinition.Sounds and the necessary parameters.
String	getName()
private com.google.gson.JsonObject	mapToJson(Map<String,SoundDefinition> map)
abstract void	registerSounds()	Registers the sound definitions that should be generated via one of the add methods.
CompletableFuture<?>	run(CachedOutput cache)
private CompletableFuture<?>	save(CachedOutput cache, Path targetFile)
protected static SoundDefinition.Sound	sound(String name)	Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.
protected static SoundDefinition.Sound	sound(String name, SoundDefinition.SoundType type)	Creates a new sound with the given name and type.
protected static SoundDefinition.Sound	sound(ResourceLocation name)	Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.
protected static SoundDefinition.Sound	sound(ResourceLocation name, SoundDefinition.SoundType type)	Creates a new sound with the given name and type.
private void	validate()
private boolean	validate(String name, SoundDefinition def)
private boolean	validate(String name, SoundDefinition.Sound sound)
private boolean	validateEvent(String soundName, ResourceLocation name)
private boolean	validateSound(String soundName, ResourceLocation name)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

output

private final PackOutput output

modId

private final String modId

helper

private final ExistingFileHelper helper

sounds

private final Map<String,SoundDefinition> sounds

Constructor Details

SoundDefinitionsProvider

protected SoundDefinitionsProvider(PackOutput output,
 String modId,
 ExistingFileHelper helper)

Creates a new instance of this data provider.

Parameters:

output - The PackOutput instance provided by the data generator.

modId - The mod ID of the current mod.

helper - The existing file helper provided by the event you are initializing this provider in.

Method Details

registerSounds

public abstract void registerSounds()

Registers the sound definitions that should be generated via one of the add methods.

run

public CompletableFuture<?> run(CachedOutput cache)

Specified by:

run in interface DataProvider

getName

public String getName()

Specified by:

getName in interface DataProvider

definition

protected static SoundDefinition definition()

Creates a new SoundDefinition, which will host a set of SoundDefinition.Sounds and the necessary parameters.

sound

protected static SoundDefinition.Sound sound(ResourceLocation name,
 SoundDefinition.SoundType type)

Creates a new sound with the given name and type.

Parameters:

name - The name of the sound to create.

type - The type of sound to create.

sound

protected static SoundDefinition.Sound sound(ResourceLocation name)

Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.

Parameters:

name - The name of the sound to create.

sound

protected static SoundDefinition.Sound sound(String name,
 SoundDefinition.SoundType type)

Creates a new sound with the given name and type.

Parameters:

name - The name of the sound to create.

type - The type of sound to create.

sound

protected static SoundDefinition.Sound sound(String name)

Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.

Parameters:

name - The name of the sound to create.

add

protected void add(Supplier<SoundEvent> soundEvent,
 SoundDefinition definition)

Adds the entry name associated with the supplied SoundEvent with the given SoundDefinition to the list.

This method should be preferred when dealing with a RegistryObject or RegistryDelegate.

Parameters:

soundEvent - A Supplier for the given SoundEvent.

definition - A SoundDefinition that defines the given sound.

add

protected void add(SoundEvent soundEvent,
 SoundDefinition definition)

Adds the entry name associated with the given SoundEvent with the SoundDefinition to the list.

This method should be preferred when a SoundEvent is already available in the method context. If you already have a Supplier for it, refer to add(Supplier, SoundDefinition).

Parameters:

soundEvent - A SoundEvent.

definition - The SoundDefinition that defines the given event.

add

protected void add(ResourceLocation soundEvent,
 SoundDefinition definition)

Adds the SoundEvent referenced by the given ResourceLocation with the SoundDefinition to the list.

Parameters:

soundEvent - The ResourceLocation that identifies the event.

definition - The SoundDefinition that defines the given event.

add

protected void add(String soundEvent,
 SoundDefinition definition)

Adds the SoundEvent with the specified name along with its SoundDefinition to the list.

The given sound event must NOT contain the namespace the name is a part of, since the sound definition specification doesn't allow sounds to be defined outside the namespace they're in. For this reason, any namespace will automatically be stripped from the name.

Parameters:

soundEvent - The name of the SoundEvent.

definition - The SoundDefinition that defines the given event.

addSounds

private void addSounds(String soundEvent,
 SoundDefinition definition)

validate

private void validate()

validate

private boolean validate(String name,
 SoundDefinition def)

validate

private boolean validate(String name,
 SoundDefinition.Sound sound)

validateSound

private boolean validateSound(String soundName,
 ResourceLocation name)

validateEvent

private boolean validateEvent(String soundName,
 ResourceLocation name)

save

private CompletableFuture<?> save(CachedOutput cache,
 Path targetFile)

mapToJson

private com.google.gson.JsonObject mapToJson(Map<String,SoundDefinition> map)