team.unnamed.creative.sound

Interface SoundEvent.Builder

Enclosing interface:

SoundEvent

public static interface SoundEvent.Builder

Builder implementation for ease the construction of SoundEvent instances

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default @NotNull SoundEvent.Builder	addSound(Sound sound) Adds a sound to this sound event.
@NotNull SoundEvent.Builder	addSound(@NotNull SoundEntry soundEntry) Adds a sound to this sound event.
default @NotNull SoundEvent.Builder	addSound(@NotNull SoundEvent soundEvent) Adds a sound to this sound event.
@NotNull SoundEvent	build() Finishes building the SoundEvent instance using the previously set values
@NotNull SoundEvent.Builder	key(@NotNull net.kyori.adventure.key.Key key) Sets the sound event's key
@NotNull SoundEvent.Builder	replace(boolean replace) Sets whether the sounds listed in SoundEvent.sounds() should replace the sounds listed in the default sound registry for this sound event.
@NotNull SoundEvent.Builder	sounds(@NotNull java.util.List<SoundEntry> sounds) Sets the sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered
default @NotNull SoundEvent.Builder	sounds(SoundEntry... sounds) Sets the sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered
@NotNull SoundEvent.Builder	subtitle(@Nullable java.lang.String subtitle) Sets the sound event subtitle, which is translated as the subtitle of the sound if "Show Subtitles" is enabled in-game

Method Detail

key

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEvent.Builder key(@NotNull
                                                                         @NotNull net.kyori.adventure.key.Key key)

Sets the sound event's key

Parameters:

key - The sound event's key

Returns:

This builder

Since:

1.0.0

replace

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEvent.Builder replace(boolean replace)

Sets whether the sounds listed in SoundEvent.sounds() should replace the sounds listed in the default sound registry for this sound event. False if the sounds listed should be added to the list of default sounds

Parameters:

replace - True to replace default sounds

Returns:

This builder

Since:

1.0.0

subtitle

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEvent.Builder subtitle(@Nullable
                                                                              @Nullable java.lang.String subtitle)

Sets the sound event subtitle, which is translated as the subtitle of the sound if "Show Subtitles" is enabled in-game

Parameters:

subtitle - The sound subtitle

Returns:

This builder

Since:

1.0.0

sounds

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEvent.Builder sounds(@NotNull
                                                                            @NotNull java.util.List<SoundEntry> sounds)

Sets the sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered

Parameters:

sounds - The sounds this sound event uses

Returns:

This builder

Since:

1.0.0

addSound

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEvent.Builder addSound(@NotNull
                                                                              @NotNull SoundEntry soundEntry)

Adds a sound to this sound event.

Parameters:

soundEntry - The sound entry

Returns:

This builder

Since:

1.1.0

addSound

@Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEvent.Builder addSound(@NotNull
                                                                                      Sound sound)

Adds a sound to this sound event.

Parameters:

sound - The sound

Returns:

This builder

Since:

1.1.0

addSound

@Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEvent.Builder addSound(@NotNull
                                                                                      @NotNull SoundEvent soundEvent)

Adds a sound to this sound event.

Parameters:

soundEvent - The sound event

Returns:

This builder

Since:

1.1.0

sounds

@Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEvent.Builder sounds(@NotNull
                                                                                    SoundEntry... sounds)

Sets the sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered

Parameters:

sounds - The sounds this sound event uses

Returns:

This builder

Since:

1.0.0

build

@NotNull
@NotNull SoundEvent build()

Finishes building the SoundEvent instance using the previously set values

Returns:

A new instance

Since:

1.0.0