Interface TropicalFishBucketMeta

All Superinterfaces:
Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder, PersistentDataViewHolder

@NullMarked public interface TropicalFishBucketMeta extends ItemMeta
Represents a bucket of tropical fish.
  • Method Details

    • getPatternColor

      DyeColor getPatternColor()
      Gets the color of the fish's pattern.

      Plugins should check that hasPatternColor() returns true before calling this method.

      Returns:
      pattern color
      Throws:
      IllegalStateException - if no pattern color is set
    • setPatternColor

      void setPatternColor(DyeColor color)
      Sets the color of the fish's pattern.
      Parameters:
      color - new pattern color
    • getBodyColor

      DyeColor getBodyColor()
      Gets the color of the fish's body.

      Plugins should check that hasBodyColor() returns true before calling this method.

      Returns:
      body color
      Throws:
      IllegalStateException - if no body color is set
    • setBodyColor

      void setBodyColor(DyeColor color)
      Sets the color of the fish's body.
      Parameters:
      color - new body color
    • getPattern

      TropicalFish.Pattern getPattern()
      Gets the fish's pattern.

      Plugins should check that hasPattern() returns true before calling this method.

      Returns:
      pattern
      Throws:
      IllegalStateException - if no pattern is set
    • setPattern

      void setPattern(TropicalFish.Pattern pattern)
      Sets the fish's pattern.
      Parameters:
      pattern - new pattern
    • hasPattern

      boolean hasPattern()
      Checks for the existence of a pattern.
      Returns:
      if there is a pattern
    • hasBodyColor

      boolean hasBodyColor()
      Checks for the existence of a body color.
      Returns:
      if there is a body color
    • hasPatternColor

      boolean hasPatternColor()
      Checks for the existence of a pattern color.
      Returns:
      if there is a pattern color
    • hasVariant

      @Deprecated(since="26.2", forRemoval=true) boolean hasVariant()
      Deprecated, for removal: This API element is subject to removal in a future version.
      the variant tag is no longer used and instead split into its own set of components
      Checks for the existence of a variant tag indicating a specific fish will be spawned.
      Returns:
      if there is a variant
      See Also:
    • clone

      Specified by:
      clone in interface ItemMeta