Record Class LoginState

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.LoginState
Record Components:
state - the primary login state value
loginProgress - the login progress indicator (e.g., loading percentage)
loginStatus - the login status code (e.g., success, invalid credentials)
public record LoginState(int state, int loginProgress, int loginStatus) extends Record
The current login state of the game client.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LoginState(int state, int loginProgress, int loginStatus)
    Creates an instance of a LoginState record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    loginProgress()
    Returns the value of the loginProgress record component.
    int
    loginStatus()
    Returns the value of the loginStatus record component.
    int
    state()
    Returns the value of the state record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LoginState

      public LoginState(int state, int loginProgress, int loginStatus)
      Creates an instance of a LoginState record class.
      Parameters:
      state - the value for the state record component
      loginProgress - the value for the loginProgress record component
      loginStatus - the value for the loginStatus record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • state

      public int state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • loginProgress

      public int loginProgress()
      Returns the value of the loginProgress record component.
      Returns:
      the value of the loginProgress record component

    • loginStatus

      public int loginStatus()
      Returns the value of the loginStatus record component.
      Returns:
      the value of the loginStatus record component