Package com.viaversion.viaversion.api.minecraft.item.data

Record Class UseEffects

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.minecraft.item.data.UseEffects
public record UseEffects(boolean canSprint, boolean interactVibrations, float speedMultiplier) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Type<UseEffects>
    TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    UseEffects(boolean canSprint, boolean interactVibrations, float speedMultiplier)
    Creates an instance of a UseEffects record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canSprint()
    Returns the value of the canSprint 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.
    boolean
    interactVibrations()
    Returns the value of the interactVibrations record component.
    float
    speedMultiplier()
    Returns the value of the speedMultiplier 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

  • Field Details

  • Constructor Details

    • UseEffects

      public UseEffects(boolean canSprint, boolean interactVibrations, float speedMultiplier)
      Creates an instance of a UseEffects record class.
      Parameters:
      canSprint - the value for the canSprint record component
      interactVibrations - the value for the interactVibrations record component
      speedMultiplier - the value for the speedMultiplier 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 '=='.
      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.

    • canSprint

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

    • interactVibrations

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

    • speedMultiplier

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