Package org.bukkit.inventory.meta.components

Interface JukeboxPlayableComponent

All Superinterfaces:

ConfigurationSerializable

@Experimental
public interface JukeboxPlayableComponent
extends ConfigurationSerializable

Represents a component which can be inserted into a jukebox.

Method Summary

Modifier and Type	Method	Description
JukeboxSong	getSong()	Gets the song assigned to this component.
NamespacedKey	getSongKey()	Gets the key of the song assigned to this component.
boolean	isShowInTooltip()	Gets if the song will show in the item tooltip.
void	setShowInTooltip(boolean show)	Sets if the song will show in the item tooltip.
void	setSong(JukeboxSong song)	Sets the song assigned to this component.
void	setSongKey(NamespacedKey song)	Sets the key of the song assigned to this component.

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Method Details

getSong

@Nullable
JukeboxSong getSong()

Gets the song assigned to this component.

Returns:

song, or null if the song does not exist on the server

getSongKey

@NotNull
NamespacedKey getSongKey()

Gets the key of the song assigned to this component.

Returns:

the song key

setSong

void setSong(@NotNull
 JukeboxSong song)

Sets the song assigned to this component.

Parameters:

song - the song

setSongKey

void setSongKey(@NotNull
 NamespacedKey song)

Sets the key of the song assigned to this component.

Parameters:

song - the song key

isShowInTooltip

boolean isShowInTooltip()

Gets if the song will show in the item tooltip.

Returns:

if the song will show in the tooltip

setShowInTooltip

void setShowInTooltip(boolean show)

Sets if the song will show in the item tooltip.

Parameters:

show - true if the song will show in the tooltip