Record Class SearchParameters

java.lang.Object
java.lang.Record
io.hymods.lib.data.SearchParameters
public record SearchParameters(com.hypixel.hytale.math.vector.Vector3d center, double radius, boolean includePlayer, boolean includeNPC, boolean includeLiving, String filterType) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchParameters(com.hypixel.hytale.math.vector.Vector3d center, double radius)
    Default constructor including all entity types and no filter.
    SearchParameters(com.hypixel.hytale.math.vector.Vector3d center, double radius, boolean includePlayer, boolean includeNPC, boolean includeLiving, String filterType)
    Full constructor allowing customization of entity types and filter.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.hypixel.hytale.math.vector.Vector3d
    center()
    Returns the value of the center record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    filterType()
    Returns the value of the filterType record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    includeLiving()
    Returns the value of the includeLiving record component.
    boolean
    includeNPC()
    Returns the value of the includeNPC record component.
    boolean
    includePlayer()
    Returns the value of the includePlayer record component.
    double
    radius()
    Returns the value of the radius record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • SearchParameters

      public SearchParameters(com.hypixel.hytale.math.vector.Vector3d center, double radius)
      Default constructor including all entity types and no filter.
      Parameters:
      center - the center point of the search
      radius - the radius of the search

    • SearchParameters

      public SearchParameters(com.hypixel.hytale.math.vector.Vector3d center, double radius, boolean includePlayer, boolean includeNPC, boolean includeLiving, String filterType)
      Full constructor allowing customization of entity types and filter.
      Parameters:
      center - the center point of the search
      radius - the radius of the search
      includePlayer - whether to include player entities
      includeNPC - whether to include NPC entities
      includeLiving - whether to include living entities
      filterType - the type of filter to apply (can be null)

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

    • center

      public com.hypixel.hytale.math.vector.Vector3d center()
      Returns the value of the center record component.
      Returns:
      the value of the center record component

    • radius

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

    • includePlayer

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

    • includeNPC

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

    • includeLiving

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

    • filterType

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