Enum GameState

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

    public enum GameState
    extends java.lang.Enum<GameState>
    An enumeration of game states the client is in.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getState()
      The raw state value.
      static GameState of​(int state)
      Utility method that maps the rank value to its respective GameState value.
      static GameState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GameState[] 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

      • UNKNOWN

        public static final GameState UNKNOWN
        Unknown game state.
      • STARTING

        public static final GameState STARTING
        The client is starting.
      • LOGIN_SCREEN

        public static final GameState LOGIN_SCREEN
        The client is at the login screen.
      • LOGIN_SCREEN_AUTHENTICATOR

        public static final GameState LOGIN_SCREEN_AUTHENTICATOR
        The client is at the login screen entering authenticator code.
      • LOGGING_IN

        public static final GameState LOGGING_IN
        There is a player logging in.
      • LOADING

        public static final GameState LOADING
        The game is being loaded.
      • LOGGED_IN

        public static final GameState LOGGED_IN
        The user has successfully logged in.
      • CONNECTION_LOST

        public static final GameState CONNECTION_LOST
        Connection to the server was lost.
      • HOPPING

        public static final GameState HOPPING
        A world hop is taking place.
    • Method Detail

      • values

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

        public static GameState 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
      • of

        public static GameState of​(int state)
        Utility method that maps the rank value to its respective GameState value.
        Parameters:
        state - the raw state value
        Returns:
        the gamestate
      • getState

        public int getState()
        The raw state value.