Record Class LocationWrapper

java.lang.Object
java.lang.Record
kr.toxicity.hud.api.adapter.LocationWrapper
Record Components:
world - world
x - x coordinate
y - y coordinate
z - z coordinate
pitch - player's pitch
yaw - player's yaw
public record LocationWrapper(@NotNull WorldWrapper world, double x, double y, double z, float pitch, float yaw) extends Record
A wrapper class of location.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocationWrapper(@NotNull WorldWrapper world, double x, double y, double z, float pitch, float yaw)
    Creates an instance of a LocationWrapper record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull LocationWrapper
    deserialize(@NotNull com.google.gson.JsonObject data)
    Finds location from JSON.
    static @NotNull LocationWrapper
    deserialize(@NotNull YamlObject data)
    Finds location from YAML.
    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.
    float
    pitch()
    Returns the value of the pitch record component.
    @NotNull Map<String,Object>
    serialize()
    Serializes to map.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull WorldWrapper
    world()
    Returns the value of the world record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    float
    yaw()
    Returns the value of the yaw record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

  • Constructor Details

    • LocationWrapper

      public LocationWrapper(@NotNull @NotNull WorldWrapper world, double x, double y, double z, float pitch, float yaw)
      Creates an instance of a LocationWrapper record class.
      Parameters:
      world - the value for the world 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
      pitch - the value for the pitch record component
      yaw - the value for the yaw record component

  • Method Details

    • deserialize

      @NotNull public static @NotNull LocationWrapper deserialize(@NotNull @NotNull YamlObject data)
      Finds location from YAML.
      Parameters:
      data - raw data
      Returns:
      location

    • deserialize

      @NotNull public static @NotNull LocationWrapper deserialize(@NotNull @NotNull com.google.gson.JsonObject data)
      Finds location from JSON.
      Parameters:
      data - raw data
      Returns:
      location

    • serialize

      @NotNull public @NotNull Map<String,Object> serialize()
      Serializes to map.
      Returns:
      map

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

    • world

      @NotNull public @NotNull WorldWrapper world()
      Returns the value of the world record component.
      Returns:
      the value of the world record component

    • x

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

    • y

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

    • z

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

    • pitch

      public float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component

    • yaw

      public float yaw()
      Returns the value of the yaw record component.
      Returns:
      the value of the yaw record component