Package net.kyori.adventure.bossbar

Enum BossBar.Flag

java.lang.Object
java.lang.Enum<BossBar.Flag>
net.kyori.adventure.bossbar.BossBar.Flag
All Implemented Interfaces:
Serializable, Comparable<BossBar.Flag>
Enclosing interface:
BossBar
public static enum BossBar.Flag extends Enum<BossBar.Flag>
Flags to control toggleable effects of a bossbar.
Since:
4.0.0

  • Enum Constant Details

    • DARKEN_SCREEN

      public static final BossBar.Flag DARKEN_SCREEN
      If the screen should be darkened.
      Since:
      4.0.0
      Since Minecraft:
      1.9

    • PLAY_BOSS_MUSIC

      public static final BossBar.Flag PLAY_BOSS_MUSIC
      If boss music should be played.
      Since:
      4.0.0
      Since Minecraft:
      1.9

    • CREATE_WORLD_FOG

      public static final BossBar.Flag CREATE_WORLD_FOG
      If world fog should be created.
      Since:
      4.0.0
      Since Minecraft:
      1.9

  • Field Details

    • NAMES

      public static final Index<String,BossBar.Flag> NAMES
      The name map.

      These names are not "official", but we want to provide them to allow serializers to be consistent.

      Since:
      4.0.0

  • Method Details

    • values

      public static BossBar.Flag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static BossBar.Flag valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null