Record Class LaunchOptions

java.lang.Object
java.lang.Record
com.botwithus.bot.api.script.LaunchOptions
Record Components:
characterIndex - for a Steam account, which character to play; NO_CHARACTER otherwise
public record LaunchOptions(int characterIndex) extends Record
Options for ClientLauncher.launch(String, LaunchOptions).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NO_CHARACTER
    No particular character: the account's default.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LaunchOptions(int characterIndex)
    Creates an instance of a LaunchOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    characterIndex()
    Returns the value of the characterIndex record component.
    static LaunchOptions
    defaults()
     
    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.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • NO_CHARACTER

      public static final int NO_CHARACTER
      No particular character: the account's default.
      See Also:

  • Constructor Details

    • LaunchOptions

      public LaunchOptions(int characterIndex)
      Creates an instance of a LaunchOptions record class.
      Parameters:
      characterIndex - the value for the characterIndex record component

  • Method Details

    • defaults

      public static LaunchOptions defaults()
      Returns:
      options with no particular character

    • 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.

    • characterIndex

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