Package io.papermc.paper.registry.data

Interface JukeboxSongRegistryEntry.Builder

All Superinterfaces:

JukeboxSongRegistryEntry, RegistryBuilder<JukeboxSong>

Enclosing interface:

JukeboxSongRegistryEntry

@Experimental
@NonExtendable
public static interface JukeboxSongRegistryEntry.Builder
extends JukeboxSongRegistryEntry, RegistryBuilder<JukeboxSong>

A mutable builder for the JukeboxSongRegistryEntry plugins may change in applicable registry events.

The following values are required for each builder:

• soundEvent(TypedKey), soundEvent(Consumer) or soundEvent(RegistryHolder)
• description(Component)
• lengthInSeconds(float)
• comparatorOutput(int)

Nested Class Summary

Nested classes/interfaces inherited from interface io.papermc.paper.registry.data.JukeboxSongRegistryEntry

JukeboxSongRegistryEntry.Builder

Method Summary

Modifier and Type	Method	Description
JukeboxSongRegistryEntry.Builder	comparatorOutput(@org.jetbrains.annotations.Range(from=0L, to=15L) int comparatorOutput)	Sets the comparator output for this song.
JukeboxSongRegistryEntry.Builder	description(Component description)	Sets the description for this song.
JukeboxSongRegistryEntry.Builder	lengthInSeconds(@org.checkerframework.checker.index.qual.Positive float lengthInSeconds)	Sets the length in seconds for this song.
JukeboxSongRegistryEntry.Builder	soundEvent(RegistryHolder<Sound,SoundEventRegistryEntry> soundEvent)	Sets the sound event for this song.
JukeboxSongRegistryEntry.Builder	soundEvent(TypedKey<Sound> soundEvent)	Sets the sound event for this song to a sound event present in the RegistryKey.SOUND_EVENT registry.
JukeboxSongRegistryEntry.Builder	soundEvent(Consumer<RegistryBuilderFactory<Sound,? extends SoundEventRegistryEntry.Builder>> soundEvent)	Sets the sound event for this song to a new sound event.

Methods inherited from interface io.papermc.paper.registry.data.JukeboxSongRegistryEntry

comparatorOutput, description, lengthInSeconds, soundEvent

Method Details

soundEvent

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder soundEvent(TypedKey<Sound> soundEvent)

Sets the sound event for this song to a sound event present in the RegistryKey.SOUND_EVENT registry.

This will override both soundEvent(Consumer) and soundEvent(RegistryHolder)

Parameters:

soundEvent - the sound event

Returns:

this builder

See Also:

• soundEvent(Consumer)

soundEvent

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder soundEvent(Consumer<RegistryBuilderFactory<Sound,? extends SoundEventRegistryEntry.Builder>> soundEvent)

Sets the sound event for this song to a new sound event.

This will override both soundEvent(TypedKey) and soundEvent(RegistryHolder)

Parameters:

soundEvent - the sound event

Returns:

this builder

See Also:

• soundEvent(TypedKey)

soundEvent

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder soundEvent(RegistryHolder<Sound,SoundEventRegistryEntry> soundEvent)

Sets the sound event for this song.

This will override both soundEvent(Consumer) and soundEvent(TypedKey)

Parameters:

soundEvent - the sound event

Returns:

this builder

See Also:

• soundEvent(TypedKey)
• soundEvent(Consumer)

description

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder description(Component description)

Sets the description for this song.

Parameters:

description - the description

Returns:

this builder

lengthInSeconds

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder lengthInSeconds(@org.checkerframework.checker.index.qual.Positive float lengthInSeconds)

Sets the length in seconds for this song.

Parameters:

lengthInSeconds - the length in seconds (positive)

Returns:

this builder

comparatorOutput

@Contract(value="_ -> this",
          mutates="this")
JukeboxSongRegistryEntry.Builder comparatorOutput(@org.jetbrains.annotations.Range(from=0L, to=15L) int comparatorOutput)

Sets the comparator output for this song.

Parameters:

comparatorOutput - the comparator output [0-15]

Returns:

this builder