Package net.kyori.adventure.bossbar

Enum BossBar.Flag

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Index<java.lang.String,​BossBar.Flag> NAMES
      The name map.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BossBar.Flag valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BossBar.Flag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • NAMES

        public static final Index<java.lang.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 Detail

      • values

        public static BossBar.Flag[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BossBar.Flag c : BossBar.Flag.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BossBar.Flag valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null