Package ml.karmaconfigs.api.common.boss

Class BossProvider<T>

java.lang.Object
ml.karmaconfigs.api.common.boss.BossProvider<T>
Type Parameters:
T - the bar provider ( target type to display to )
public abstract class BossProvider<T> extends Object
Karma boss bar provider

  • Constructor Details

    • BossProvider

      public BossProvider()

  • Method Details

    • color

      public abstract BossProvider<T> color​(BossColor paramBossColor)
      Set the boss bar color
      Parameters:
      paramBossColor - the boss bar color
      Returns:
      this boss bar instance

    • style

      public abstract BossProvider<T> style​(BossType paramBossType)
      Set the boss bar style
      Parameters:
      paramBossType - the boss bar style
      Returns:
      this boss bar instance

    • progress

      public abstract BossProvider<T> progress​(ProgressiveBar paramProgressiveBar)
      Set the boss bar progress type
      Parameters:
      paramProgressiveBar - the boss bar progress type
      Returns:
      this boss bar instance

    • cancel

      public abstract void cancel()
      Destroy the current boss bar

    • displayBar

      protected abstract void displayBar​(Collection<T> paramCollection)
      Display the boss bar to the specified players
      Parameters:
      paramCollection - the players to display to

    • scheduleBar

      public abstract void scheduleBar​(Collection<T> paramCollection)
      Schedule the bar to the specified players
      Parameters:
      paramCollection - the players to display to

    • scheduleBar

      public abstract void scheduleBar​(T paramT)
      Schedule the bar to the specified player
      Parameters:
      paramT - the player to display to

    • getBarsAmount

      public abstract int getBarsAmount()
      Get the amount of bars that exist
      Returns:
      the amount of bars created

    • getBarId

      public abstract int getBarId()
      Get the current boss bar id
      Returns:
      the current boss bar id

    • update

      public abstract boolean update​(String paramString, boolean paramBoolean)
      Update the boss bar
      Parameters:
      paramString - the new boss bar text
      paramBoolean - restart the bar progress
      Returns:
      if the boss bar could be updated

    • displayTime

      public abstract BossProvider<T> displayTime​(double paramDouble)
      Set the boss bar display time
      Parameters:
      paramDouble - the boss bar display time
      Returns:
      the boss bar display time

    • isValid

      public abstract boolean isValid()
      Get if the boss bar is valid
      Returns:
      if the boss bar is valid

    • isCancelled

      public abstract boolean isCancelled()
      Get if the boss bar is cancelled
      Returns:
      if the boss bar is cancelled

    • getTitle

      public abstract String getTitle()
      Get the boss bar title
      Returns:
      the boss bar title

    • getColor

      public abstract BossColor getColor()
      Get the boss bar color
      Returns:
      the boss bar color

    • getStyle

      public abstract BossType getStyle()
      Get the boss bar style
      Returns:
      the boss bar style