Record Class Waypoint

java.lang.Object
java.lang.Record
de.luckymcdev.foundryengine.common.waypoint.Waypoint
public record Waypoint(String name, String icon, int x, int y, int z, Color color) extends Record
Canonical waypoint data model.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Waypoint(String name, String icon, int x, int y, int z, Color color)
    Creates an instance of a Waypoint record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Color
    color()
    Returns the value of the color record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static Waypoint
    fromNbt(net.minecraft.nbt.CompoundTag tag)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    icon()
    Returns the value of the icon record component.
    String
    name()
    Returns the value of the name record component.
    net.minecraft.nbt.CompoundTag
    toNbt()
     
    final String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Waypoint

      public Waypoint(String name, String icon, int x, int y, int z, Color color)
      Creates an instance of a Waypoint record class.
      Parameters:
      name - the value for the name record component
      icon - the value for the icon record component
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      color - the value for the color record component

  • Method Details

    • fromNbt

      public static Waypoint fromNbt(net.minecraft.nbt.CompoundTag tag)

    • toNbt

      public net.minecraft.nbt.CompoundTag toNbt()

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • icon

      public String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • x

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

    • y

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

    • z

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

    • color

      public Color color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component