Class BossBar


  • public class BossBar
    extends MessageDisplay
    A wrapper for the Bukkit BossBar API
    • Constructor Summary

      Constructors 
      Constructor Description
      BossBar​(java.lang.String text)
      Create a Bossbar
      BossBar​(java.lang.String text, int time)
      Create a BossBar
      BossBar​(java.lang.String text, int time, TimedEvent timedEvent)
      Create a BossBar
      BossBar​(java.lang.String text, int time, org.bukkit.boss.BarColor barColor, org.bukkit.boss.BarStyle barStyle)
      Create a BossBar progress = 1.0
      BossBar​(java.lang.String text, int time, org.bukkit.boss.BarColor barColor, org.bukkit.boss.BarStyle barStyle, java.lang.Double progress)
      Create a BossBar
      BossBar​(java.lang.String text, int time, org.bukkit.boss.BarColor barColor, org.bukkit.boss.BarStyle barStyle, java.lang.Double progress, TimedEvent timedEvent)
      Create a BossBar
      BossBar​(java.lang.String text, int time, org.bukkit.boss.BarColor barColor, org.bukkit.boss.BarStyle barStyle, TimedEvent timedEvent)
      Create a BossBar progress = 1.0
      BossBar​(java.lang.String text, TimedEvent timedEvent)
      Create a Bossbar
    • Method Summary

      Modifier and Type Method Description
      static void clear​(org.bukkit.entity.Player player)
      Clear the BossBar being shown to the player
      static BossBar getBossBar​(org.bukkit.entity.Player player)
      Gets boss bar.
      org.bukkit.boss.BossBar getBukkitBar()
      Gets bukkit bar.
      java.lang.String getText()  
      int getTime()
      Get the time
      TimedEvent getTimedEvent()
      Gets timed event.
      void send​(org.bukkit.entity.Player player)
      Sends a BossBar for a set amount of time
      void setText​(java.lang.String text)
      Set the text
      void setTimedEvent​(TimedEvent timedEvent)
      Set the TimedEvent
      void stop​(org.bukkit.entity.Player player)
      Clear the bossbar off the players screen
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BossBar

        public BossBar​(java.lang.String text)
        Create a Bossbar

        time = 2 color = white style = solid progress = 1.0

        Parameters:
        text - The Text
      • BossBar

        public BossBar​(java.lang.String text,
                       int time)
        Create a BossBar

        color = white style = solid progress = 1.0

        Parameters:
        text - The Text
        time - The Time
      • BossBar

        public BossBar​(java.lang.String text,
                       int time,
                       org.bukkit.boss.BarColor barColor,
                       org.bukkit.boss.BarStyle barStyle)
        Create a BossBar progress = 1.0
        Parameters:
        text - The text
        time - The time
        barColor - the Barcolor
        barStyle - The Barstyle
      • BossBar

        public BossBar​(java.lang.String text,
                       int time,
                       org.bukkit.boss.BarColor barColor,
                       org.bukkit.boss.BarStyle barStyle,
                       java.lang.Double progress)
        Create a BossBar
        Parameters:
        text - The text
        time - The Time
        barColor - The Barcolor
        barStyle - The BarStyle
        progress - The progress
      • BossBar

        public BossBar​(java.lang.String text,
                       TimedEvent timedEvent)
        Create a Bossbar

        time = 2 color = white style = solid progress = 1.0

        Parameters:
        text - The text
        timedEvent - The TimedEvent
      • BossBar

        public BossBar​(java.lang.String text,
                       int time,
                       TimedEvent timedEvent)
        Create a BossBar

        color = white style = solid progress = 1.0

        Parameters:
        text - The text
        time - The time
        timedEvent - The TimedEvent
      • BossBar

        public BossBar​(java.lang.String text,
                       int time,
                       org.bukkit.boss.BarColor barColor,
                       org.bukkit.boss.BarStyle barStyle,
                       TimedEvent timedEvent)
        Create a BossBar progress = 1.0
        Parameters:
        text - The text
        time - The time
        barColor - The bar color
        barStyle - The bar style
        timedEvent - The TimedEvent
      • BossBar

        public BossBar​(java.lang.String text,
                       int time,
                       org.bukkit.boss.BarColor barColor,
                       org.bukkit.boss.BarStyle barStyle,
                       java.lang.Double progress,
                       TimedEvent timedEvent)
        Create a BossBar
        Parameters:
        text - The text
        time - The time
        barColor - The bar color
        barStyle - The bar style
        progress - The bar's progress
        timedEvent - The TimedEvent
    • Method Detail

      • clear

        public static void clear​(org.bukkit.entity.Player player)
        Clear the BossBar being shown to the player
        Parameters:
        player - the player
      • getBossBar

        public static BossBar getBossBar​(org.bukkit.entity.Player player)
        Gets boss bar.
        Parameters:
        player - The player
        Returns:
        Get the BossBar being shown to the player
      • getTime

        public int getTime()
        Get the time
        Specified by:
        getTime in class MessageDisplay
        Returns:
        the time left
      • stop

        public void stop​(org.bukkit.entity.Player player)
        Clear the bossbar off the players screen
        Specified by:
        stop in class MessageDisplay
        Parameters:
        player - The player
      • getBukkitBar

        public org.bukkit.boss.BossBar getBukkitBar()
        Gets bukkit bar.
        Returns:
        Get the BukkitBossBar
      • setTimedEvent

        public void setTimedEvent​(TimedEvent timedEvent)
        Set the TimedEvent
        Overrides:
        setTimedEvent in class TimedObject
        Parameters:
        timedEvent - The TimedEvent
      • getText

        public java.lang.String getText()
        Specified by:
        getText in class MessageDisplay
        Returns:
        Get the text
      • setText

        public void setText​(java.lang.String text)
        Set the text
        Specified by:
        setText in class MessageDisplay
        Parameters:
        text - The text
      • send

        public void send​(org.bukkit.entity.Player player)
        Sends a BossBar for a set amount of time
        Specified by:
        send in class MessageDisplay
        Parameters:
        player - The player