Package net.fabricmc.fabric.api.client.datagen.v1.builder

Interface SoundTypeBuilder

@NonExtendable
public interface SoundTypeBuilder

Provides functionality for building entries that go into a sounds.json file.

Use in conjunction with FabricSoundsProvider to generate sound definitions.

See Also:

• SoundManager
• WeightedSoundSet

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SoundTypeBuilder.EntryBuilder	Builder for creating a weighted sound entry that can be played for a particular sound type.
static enum	SoundTypeBuilder.RegistrationType	Represents the type of weighted sound entry.

Method Summary

Modifier and Type	Method	Description
SoundTypeBuilder	category(SoundCategory category)	Sets the sound category the sound event must play on.
static SoundTypeBuilder	of()	Creates a new empty builder.
static SoundTypeBuilder	of(SoundEvent event)	Creates a new builder pre-filled with a subtitle translation key string based on the passed event.
SoundTypeBuilder	sound(SoundTypeBuilder.EntryBuilder sound)	Adds one sound to the event.
SoundTypeBuilder	sound(SoundTypeBuilder.EntryBuilder sound, int count)	Adds one or more sounds to the event.
SoundTypeBuilder	subtitle(@Nullable String subtitle)	Sets an optional translation key string to use for the sound's subtitle.

Method Details

of

static SoundTypeBuilder of(SoundEvent event)

Creates a new builder pre-filled with a subtitle translation key string based on the passed event.

Note: To generate a translation value, use FabricLanguageProvider.TranslationBuilder.add(SoundEvent, String).

Returns:

New sound type builder

of

static SoundTypeBuilder of()

Creates a new empty builder.

Returns:

New sound type builder

category

SoundTypeBuilder category(SoundCategory category)

Sets the sound category the sound event must play on.

The default category is SoundCategory.NEUTRAL. GUI elements should use SoundCategory.MASTER.

subtitle

SoundTypeBuilder subtitle(@Nullable
 @Nullable String subtitle)

Sets an optional translation key string to use for the sound's subtitle.

The default is null (no subtitle).

Note: To generate a translation value, use FabricLanguageProvider.TranslationBuilder.add(SoundEvent, String).

sound

SoundTypeBuilder sound(SoundTypeBuilder.EntryBuilder sound)

Adds one sound to the event.

Parameters:

sound - base sound to add

sound

SoundTypeBuilder sound(SoundTypeBuilder.EntryBuilder sound,
 int count)

Adds one or more sounds to the event.

This is a shorthand method for quickly adding multiple entries where each sound is a variant with an index at the end of their name.

Calling this with the a count value of 3 is the equivalent of doing:

builder.sound(EntryBuilder.ofFile(id.withSuffixedPath("1")); builder.sound(EntryBuilder.ofFile(id.withSuffixedPath("2")); builder.sound(EntryBuilder.ofFile(id.withSuffixedPath("3"));

Parameters:

sound - base sound to add

count - number of instances of that sound to register