Package net.timtaran.interactivemc.body.player.interaction

Record Class GrabInteraction.GrabResult

java.lang.Object
java.lang.Record
net.timtaran.interactivemc.body.player.interaction.GrabInteraction.GrabResult
Record Components:
grabbedBody - the body that was grabbed
grabConstraint - the grab constraint that was created
Enclosing class:
GrabInteraction
public static record GrabInteraction.GrabResult(@NotNull net.xmx.velthoric.core.body.VxBody grabbedBody, @Nullable net.xmx.velthoric.core.constraint.VxConstraint grabConstraint) extends Record
Result of a grab attempt.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    GrabResult(@NotNull net.xmx.velthoric.core.body.VxBody grabbedBody, @Nullable net.xmx.velthoric.core.constraint.VxConstraint grabConstraint)
    Creates an instance of a GrabResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull net.xmx.velthoric.core.body.VxBody
    grabbedBody()
    Returns the value of the grabbedBody record component.
    @Nullable net.xmx.velthoric.core.constraint.VxConstraint
    grabConstraint()
    Returns the value of the grabConstraint record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • GrabResult

      public GrabResult(@NotNull @NotNull net.xmx.velthoric.core.body.VxBody grabbedBody, @Nullable @Nullable net.xmx.velthoric.core.constraint.VxConstraint grabConstraint)
      Creates an instance of a GrabResult record class.
      Parameters:
      grabbedBody - the value for the grabbedBody record component
      grabConstraint - the value for the grabConstraint 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 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.

    • grabbedBody

      @NotNull public @NotNull net.xmx.velthoric.core.body.VxBody grabbedBody()
      Returns the value of the grabbedBody record component.
      Returns:
      the value of the grabbedBody record component

    • grabConstraint

      @Nullable public @Nullable net.xmx.velthoric.core.constraint.VxConstraint grabConstraint()
      Returns the value of the grabConstraint record component.
      Returns:
      the value of the grabConstraint record component