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
    @Nullable JukeboxSong
    getSong()
    Gets the song assigned to this component.
    @NotNull NamespacedKey
    getSongKey()
    Gets the key of the song assigned to this component.
    default boolean
    isShowInTooltip()
    Deprecated, for removal: This API element is subject to removal in a future version.
    no longer available on the component directly
    default void
    setShowInTooltip(boolean show)
    Deprecated, for removal: This API element is subject to removal in a future version.
    no longer available on the component directly
    void
    setSong(@NotNull JukeboxSong song)
    Sets the song assigned to this component.
    void
    setSongKey(@NotNull 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 @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 @NotNull NamespacedKey getSongKey()
      Gets the key of the song assigned to this component.
      Returns:
      the song key

    • setSong

      void setSong(@NotNull @NotNull JukeboxSong song)
      Sets the song assigned to this component.
      Parameters:
      song - the song

    • setSongKey

      void setSongKey(@NotNull @NotNull NamespacedKey song)
      Sets the key of the song assigned to this component.
      Parameters:
      song - the song key

    • isShowInTooltip

      @Deprecated(since="1.21.5", forRemoval=true) @Contract("-> true") default boolean isShowInTooltip()
      Deprecated, for removal: This API element is subject to removal in a future version.
      no longer available on the component directly
      Gets if the song will show in the item tooltip.
      Returns:
      if the song will show in the tooltip

    • setShowInTooltip

      @Deprecated(since="1.21.5", forRemoval=true) default void setShowInTooltip(boolean show)
      Deprecated, for removal: This API element is subject to removal in a future version.
      no longer available on the component directly
      Sets if the song will show in the item tooltip.
      Parameters:
      show - true if the song will show in the tooltip