Package me.deecaad.core.utils.shape

Record Class ShapePoint

java.lang.Object
java.lang.Record
me.deecaad.core.utils.shape.ShapePoint
Record Components:
offset - The non-null local-space offset.
direction - The non-null local-space emission normal; the zero vector means "use the emitter's direction."
public record ShapePoint(@NotNull org.bukkit.util.Vector offset, @NotNull org.bukkit.util.Vector direction) extends Record
A sample from a Shape: an offset (local-space, relative to the emitter origin) and a direction (local-space emission normal). A zero direction signals "fall back to the emitter's own direction provider."

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShapePoint(@NotNull org.bukkit.util.Vector offset, @NotNull org.bukkit.util.Vector direction)
    Creates an instance of a ShapePoint record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull ShapePoint
    at(@NotNull org.bukkit.util.Vector offset)
    Creates a ShapePoint with the given offset and a zero direction (the consumer should fall back to its own direction).
    @NotNull org.bukkit.util.Vector
    direction()
    Returns the value of the direction record component.
    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.
    @NotNull org.bukkit.util.Vector
    offset()
    Returns the value of the offset record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ShapePoint

      public ShapePoint(@NotNull @NotNull org.bukkit.util.Vector offset, @NotNull @NotNull org.bukkit.util.Vector direction)
      Creates an instance of a ShapePoint record class.
      Parameters:
      offset - the value for the offset record component
      direction - the value for the direction record component

  • Method Details

    • at

      @NotNull public static @NotNull ShapePoint at(@NotNull @NotNull org.bukkit.util.Vector offset)
      Creates a ShapePoint with the given offset and a zero direction (the consumer should fall back to its own direction).
      Parameters:
      offset - The non-null offset (defensively copied).
      Returns:
      The non-null shape point.

    • 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 Objects::equals(Object,Object).
      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.

    • offset

      @NotNull public @NotNull org.bukkit.util.Vector offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • direction

      @NotNull public @NotNull org.bukkit.util.Vector direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component