Record Class WorldMapPlacement

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.WorldMapPlacement
Record Components:
plane - 0..3
tileX - absolute world tile X
tileY - absolute world tile Y
membersOnly - whether this placement is in a members-only area
public record WorldMapPlacement(int plane, int tileX, int tileY, boolean membersOnly) extends Record
A single placement of a WorldMapElement on the world map. A given element may exist at multiple tiles (e.g. "Bank" has many placements); each entry gives the absolute tile coordinates and member-only status.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorldMapPlacement(int plane, int tileX, int tileY, boolean membersOnly)
    Creates an instance of a WorldMapPlacement 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.
    boolean
    membersOnly()
    Returns the value of the membersOnly record component.
    int
    plane()
    Returns the value of the plane record component.
    int
    tileX()
    Returns the value of the tileX record component.
    int
    tileY()
    Returns the value of the tileY 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

    • WorldMapPlacement

      public WorldMapPlacement(int plane, int tileX, int tileY, boolean membersOnly)
      Creates an instance of a WorldMapPlacement record class.
      Parameters:
      plane - the value for the plane record component
      tileX - the value for the tileX record component
      tileY - the value for the tileY record component
      membersOnly - the value for the membersOnly 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.

    • plane

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

    • tileX

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

    • tileY

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

    • membersOnly

      public boolean membersOnly()
      Returns the value of the membersOnly record component.
      Returns:
      the value of the membersOnly record component