Enum OverlayLayer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OverlayLayer>

    public enum OverlayLayer
    extends java.lang.Enum<OverlayLayer>
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABOVE_SCENE
      Render right above the scene (that contains actors and the surface)
      ABOVE_WIDGETS
      Render under the right-click menu
      ALWAYS_ON_TOP
      Render overlay above all game elements
      MANUAL
      Overlay is not rendered.
      UNDER_WIDGETS
      Render under all interfaces, but above overheads
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static OverlayLayer valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OverlayLayer[] 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

      • MANUAL

        public static final OverlayLayer MANUAL
        Overlay is not rendered. Requires using drawAfterInterface() or drawAfterLayer() to specify when to draw.
      • ABOVE_SCENE

        public static final OverlayLayer ABOVE_SCENE
        Render right above the scene (that contains actors and the surface)
      • UNDER_WIDGETS

        public static final OverlayLayer UNDER_WIDGETS
        Render under all interfaces, but above overheads
      • ABOVE_WIDGETS

        public static final OverlayLayer ABOVE_WIDGETS
        Render under the right-click menu
      • ALWAYS_ON_TOP

        public static final OverlayLayer ALWAYS_ON_TOP
        Render overlay above all game elements
    • Method Detail

      • values

        public static OverlayLayer[] 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 (OverlayLayer c : OverlayLayer.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OverlayLayer 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