Package me.deecaad.weaponmechanics.weapon.shoot.recoil

Record Class RecoilPattern.ExtraRecoilPatternData

java.lang.Object
java.lang.Record
me.deecaad.weaponmechanics.weapon.shoot.recoil.RecoilPattern.ExtraRecoilPatternData
Enclosing class:
RecoilPattern
public static record RecoilPattern.ExtraRecoilPatternData(float horizontalRecoil, float verticalRecoil, double chanceToSkip) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExtraRecoilPatternData(float horizontalRecoil, float verticalRecoil, double chanceToSkip)
    Creates an instance of a ExtraRecoilPatternData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    chanceToSkip()
    Returns the value of the chanceToSkip 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.
    float
    horizontalRecoil()
    Returns the value of the horizontalRecoil record component.
    boolean
    shouldSkip()
     
    final String
    toString()
    Returns a string representation of this record class.
    float
    verticalRecoil()
    Returns the value of the verticalRecoil record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ExtraRecoilPatternData

      public ExtraRecoilPatternData(float horizontalRecoil, float verticalRecoil, double chanceToSkip)
      Creates an instance of a ExtraRecoilPatternData record class.
      Parameters:
      horizontalRecoil - the value for the horizontalRecoil record component
      verticalRecoil - the value for the verticalRecoil record component
      chanceToSkip - the value for the chanceToSkip record component

  • Method Details

    • shouldSkip

      public boolean shouldSkip()
      Returns:
      whether to skip this recoil pattern

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

    • horizontalRecoil

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

    • verticalRecoil

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

    • chanceToSkip

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