Package org.bukkit.block

Interface Banner

All Superinterfaces:
BlockState, Metadatable, Nameable, PersistentDataHolder, TileState
public interface Banner extends TileState, Nameable
Represents a captured state of a banner.

  • Method Details

    • getBaseColor

      @NotNull @NotNull DyeColor getBaseColor()
      Returns the base color for this banner
      Returns:
      the base color

    • setBaseColor

      void setBaseColor(@NotNull @NotNull DyeColor color)
      Sets the base color for this banner. Only valid for shield pseudo banners, otherwise base depends on block type
      Parameters:
      color - the base color

    • getPatterns

      @NotNull @NotNull List<Pattern> getPatterns()
      Returns a list of patterns on this banner
      Returns:
      the patterns

    • setPatterns

      void setPatterns(@NotNull @NotNull List<Pattern> patterns)
      Sets the patterns used on this banner
      Parameters:
      patterns - the new list of patterns

    • addPattern

      void addPattern(@NotNull @NotNull Pattern pattern)
      Adds a new pattern on top of the existing patterns
      Parameters:
      pattern - the new pattern to add

    • getPattern

      @NotNull @NotNull Pattern getPattern(int i)
      Returns the pattern at the specified index
      Parameters:
      i - the index
      Returns:
      the pattern

    • removePattern

      @NotNull @NotNull Pattern removePattern(int i)
      Removes the pattern at the specified index
      Parameters:
      i - the index
      Returns:
      the removed pattern

    • setPattern

      void setPattern(int i, @NotNull @NotNull Pattern pattern)
      Sets the pattern at the specified index
      Parameters:
      i - the index
      pattern - the new pattern

    • numberOfPatterns

      int numberOfPatterns()
      Returns the number of patterns on this banner
      Returns:
      the number of patterns