Package org.bukkit.boss

Interface BossBar

  • All Known Subinterfaces:
    KeyedBossBar
    public interface BossBar

    • Method Detail

      • getTitle

        @NotNull
@NotNull String getTitle()
        Returns the title of this boss bar
        Returns:
        the title of the bar

      • setTitle

        void setTitle​(@Nullable
              @Nullable String title)
        Sets the title of this boss bar
        Parameters:
        title - the title of the bar

      • getColor

        @NotNull
@NotNull BarColor getColor()
        Returns the color of this boss bar
        Returns:
        the color of the bar

      • setColor

        void setColor​(@NotNull
              @NotNull BarColor color)
        Sets the color of this boss bar.
        Parameters:
        color - the color of the bar

      • getStyle

        @NotNull
@NotNull BarStyle getStyle()
        Returns the style of this boss bar
        Returns:
        the style of the bar

      • setStyle

        void setStyle​(@NotNull
              @NotNull BarStyle style)
        Sets the bar style of this boss bar
        Parameters:
        style - the style of the bar

      • removeFlag

        void removeFlag​(@NotNull
                @NotNull BarFlag flag)
        Remove an existing flag on this boss bar
        Parameters:
        flag - the existing flag to remove

      • addFlag

        void addFlag​(@NotNull
             @NotNull BarFlag flag)
        Add an optional flag to this boss bar
        Parameters:
        flag - an optional flag to set on the boss bar

      • hasFlag

        boolean hasFlag​(@NotNull
                @NotNull BarFlag flag)
        Returns whether this boss bar as the passed flag set
        Parameters:
        flag - the flag to check
        Returns:
        whether it has the flag

      • setProgress

        void setProgress​(double progress)
        Sets the progress of the bar. Values should be between 0.0 (empty) and 1.0 (full)
        Parameters:
        progress - the progress of the bar

      • getProgress

        double getProgress()
        Returns the progress of the bar between 0.0 and 1.0
        Returns:
        the progress of the bar

      • addPlayer

        void addPlayer​(@NotNull
               @NotNull Player player)
        Adds the player to this boss bar causing it to display on their screen.
        Parameters:
        player - the player to add

      • removePlayer

        void removePlayer​(@NotNull
                  @NotNull Player player)
        Removes the player from this boss bar causing it to be removed from their screen.
        Parameters:
        player - the player to remove

      • getPlayers

        @NotNull
@NotNull List<Player> getPlayers()
        Returns all players viewing this boss bar
        Returns:
        a immutable list of players

      • setVisible

        void setVisible​(boolean visible)
        Set if the boss bar is displayed to attached players.
        Parameters:
        visible - visible status

      • isVisible

        boolean isVisible()
        Return if the boss bar is displayed to attached players.
        Returns:
        visible status