Package gamedata

Enum TileSet.Category

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TileSet.Category>
    Enclosing class:
    TileSet
    public static enum TileSet.Category
extends java.lang.Enum<TileSet.Category>
    An enumeration of the general categories that a PageItem can fall into.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOARD_BITS
      This category is generally populated with tiles that represent small to medium-sized objects with either a game-related function or a usability-related function.
      DECORATIONS
      This category is generally populated with smaller, often non-rectangular image tiles that are designed to placed overtop TILES to customize the look of a board.
      FACES
      This special category is reserved for the faces of game components that have been added to a deck.
      OTHER
      This is a catch-all category provided for plug-in authors to use when no other category applies.
      TILES
      This category is generally populated with large rectangular image tiles designed to be placed side-by-side to quickly build up backdrops, maps, and so forth.
      TOOLS
      This special category is reserved for particular PageItem subclasses that add objects like text boxes and geometric shapes to a deck.

    • Method Summary

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

      • TOOLS

        public static final TileSet.Category TOOLS
        This special category is reserved for particular PageItem subclasses that add objects like text boxes and geometric shapes to a deck.

      • FACES

        public static final TileSet.Category FACES
        This special category is reserved for the faces of game components that have been added to a deck.

      • TILES

        public static final TileSet.Category TILES
        This category is generally populated with large rectangular image tiles designed to be placed side-by-side to quickly build up backdrops, maps, and so forth.

      • DECORATIONS

        public static final TileSet.Category DECORATIONS
        This category is generally populated with smaller, often non-rectangular image tiles that are designed to placed overtop TILES to customize the look of a board.

      • BOARD_BITS

        public static final TileSet.Category BOARD_BITS
        This category is generally populated with tiles that represent small to medium-sized objects with either a game-related function or a usability-related function. Where tiles and decorations serve primarily an aesthetic function, the positioning of board bits either affects gameplay or else helps to improve gameplay, for example, by organizing parts of the board into logical groups.

      • OTHER

        public static final TileSet.Category OTHER
        This is a catch-all category provided for plug-in authors to use when no other category applies.

    • Method Detail

      • values

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

      • valueOf

        public static TileSet.Category 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