Package org.bukkit.block

Interface Skull

All Superinterfaces:
BlockState, Metadatable, PersistentDataHolder, PersistentDataViewHolder, TileState
public interface Skull extends TileState
Represents a captured state of a skull block.

  • Method Details

    • hasOwner

      boolean hasOwner()
      Checks to see if the skull has an owner
      Returns:
      true if the skull has an owner

    • getOwner

      @Deprecated(since="1.9.4") @Nullable @Nullable String getOwner()
      Deprecated.
      See getOwningPlayer().
      Gets the owner of the skull, if one exists
      Returns:
      the owner of the skull or null if the skull does not have an owner

    • setOwner

      @Deprecated(since="1.9.4") @Contract("null -> false") boolean setOwner(@Nullable @Nullable String name)
      Deprecated.
      see setOwningPlayer(org.bukkit.OfflinePlayer).
      Sets the owner of the skull

      Involves a potentially blocking web request to acquire the profile data for the provided name.

      Parameters:
      name - the new owner of the skull
      Returns:
      true if the owner was successfully set

    • getOwningPlayer

      @Nullable @Nullable OfflinePlayer getOwningPlayer()
      Get the player which owns the skull. This player may appear as the texture depending on skull type.
      Returns:
      owning player

    • setOwningPlayer

      void setOwningPlayer(@NotNull @NotNull OfflinePlayer player)
      Set the player which owns the skull. This player may appear as the texture depending on skull type.
      Parameters:
      player - the owning player

    • setPlayerProfile

      void setPlayerProfile(@NotNull PlayerProfile profile)
      Sets this skull to use the supplied Player Profile, which can include textures already prefilled.
      Parameters:
      profile - The profile to set this Skull to use, may not be null

    • getPlayerProfile

      @Nullable PlayerProfile getPlayerProfile()
      If the skull has an owner, per hasOwner(), return the owners PlayerProfile
      Returns:
      The profile of the owner, if set

    • getOwnerProfile

      @Nullable @Deprecated @Nullable PlayerProfile getOwnerProfile()
      Deprecated.
      Use getPlayerProfile() instead.
      Gets the profile of the player who owns the skull. This player profile may appear as the texture depending on skull type.
      Returns:
      the profile of the owning player

    • setOwnerProfile

      @Deprecated void setOwnerProfile(@Nullable @Nullable PlayerProfile profile)
      Deprecated.
      Use setPlayerProfile(com.destroystokyo.paper.profile.PlayerProfile) instead.
      Sets the profile of the player who owns the skull. This player profile may appear as the texture depending on skull type.

      The profile must contain both a unique id and a skin texture. If either of these is missing, the profile must contain a name by which the server will then attempt to look up the unique id and skin texture.

      Parameters:
      profile - the profile of the owning player
      Throws:
      IllegalArgumentException - if the profile does not contain the necessary information

    • getNoteBlockSound

      @Nullable @Nullable NamespacedKey getNoteBlockSound()
      Gets the sound to play if the skull is placed on a note block.
      Note: This only works for player heads. For other heads, see Instrument.
      Returns:
      the key of the sound, or null

    • setNoteBlockSound

      void setNoteBlockSound(@Nullable @Nullable NamespacedKey noteBlockSound)
      Sets the sound to play if the skull is placed on a note block.
      Note: This only works for player heads. For other heads, see Instrument.
      Parameters:
      noteBlockSound - the key of the sound to be played, or null

    • getRotation

      @Deprecated(since="1.13") @NotNull @NotNull BlockFace getRotation()
      Deprecated.
      use BlockData
      Gets the rotation of the skull in the world (or facing direction if this is a wall mounted skull).
      Returns:
      the rotation of the skull

    • setRotation

      @Deprecated(since="1.13") void setRotation(@NotNull @NotNull BlockFace rotation)
      Deprecated.
      use BlockData
      Sets the rotation of the skull in the world (or facing direction if this is a wall mounted skull).
      Parameters:
      rotation - the rotation of the skull

    • getSkullType

      @Deprecated(since="1.13", forRemoval=true) @NotNull @NotNull SkullType getSkullType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      check Material instead
      Gets the type of skull
      Returns:
      the type of skull

    • setSkullType

      @Deprecated(since="1.13", forRemoval=true) @Contract("_ -> fail") void setSkullType(SkullType skullType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      check Material instead
      Sets the type of skull
      Parameters:
      skullType - the type of skull

    • customName

      @Nullable @Nullable Component customName()
      Get the custom name of skull.

      This name is set when placing a skull item that has a custom name. This name is only carried back to the item when broken for player heads (skeleton/creeper heads will not retain the name).

      Returns:
      Custom name of skull

    • customName

      void customName(@Nullable @Nullable Component customName)
      Set the custom name of skull.

      This name is set when placing a skull item that has a custom name. This name is only carried back to the item when broken for player heads (skeleton/creeper heads will not retain the name).

      Parameters:
      customName - Custom name of skull