Package org.xjge.core

Enum Split

java.lang.Object
java.lang.Enum<Split>
org.xjge.core.Split
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Split>, java.lang.constant.Constable
public enum Split
extends java.lang.Enum<Split>
Represents a way in which the screen can be divided during split screen mode.
Since:
2.0.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    HORIZONTAL
    The screen will be divided horizontally from side to side.
    NONE
    The screen will not be divided.
    QUARTER
    The screen will be divided evenly into quarters.
    TRISECT
    The screen will be divided evenly into three segments.
    VERTICAL
    The screen will be divided vertically from top to bottom.

  • Method Summary

    Modifier and Type Method Description
    static Split valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Split[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final Split NONE
      The screen will not be divided. Only the first viewport will be visible.

    • HORIZONTAL

      public static final Split HORIZONTAL
      The screen will be divided horizontally from side to side. Only the first and second viewports will be visible and will appear to be stacked on top of one another.

    • VERTICAL

      public static final Split VERTICAL
      The screen will be divided vertically from top to bottom. Only the first and second viewports will be visible and will appear to be positioned beside each other.

    • TRISECT

      public static final Split TRISECT
      The screen will be divided evenly into three segments. Every viewport except the fourth will be visible.

    • QUARTER

      public static final Split QUARTER
      The screen will be divided evenly into quarters. All viewports will be visible.

  • Method Details

    • values

      public static Split[] 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 Split 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