Record Class SourceTile

java.lang.Object
java.lang.Record
com.botwithus.bot.api.snapshot.SourceTile
Record Components:
tileX - absolute world tile X in the source region
tileY - absolute world tile Y in the source region
plane - source plane, 0..3 — need not equal the plane asked for
rotation - chunk rotation applied to the copy, 0..3
public record SourceTile(int tileX, int tileY, int plane, int rotation) extends Record
The static-map tile an instance tile was copied from (v19+).

Returned by DynamicRegion.sourceOf(int, int, int). The coordinates are absolute world tiles in the source region — the same coordinate space as Npc.tileX() or a baked navigation grid, not an offset and not a scene-local position. That is the whole point of the resolver: a tile inside a player-owned house resolves to the tile in the house template region that supplied its terrain, collision and scenery.

rotation() is the chunk's rotation, 0..3 in 90-degree steps, and it is not merely informational: anything directional read out of the source tile has to be rotated by it before being believed in the instance. Wall and door collision bits are the classic case, and a Location's own rotation composes with it via DynamicRegion.rotateLocRotation(int, int). Copying raw directional flags without applying this is the standard way to get an instance's collision subtly wrong.

  • Constructor Summary

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

    • SourceTile

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

    • 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

    • plane

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

    • rotation

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