Package com.fastasyncworldedit.core.command.tool.brush

Record Class RockBrush

java.lang.Object
java.lang.Record
com.fastasyncworldedit.core.command.tool.brush.RockBrush
All Implemented Interfaces:
Brush
public record RockBrush(double amplitude, double frequency, Vector3 radius) extends Record implements Brush

  • Constructor Summary

    Constructors
    Constructor
    Description
    RockBrush(double amplitude, double frequency, Vector3 radius)
    Creates an instance of a RockBrush record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    amplitude()
    Returns the value of the amplitude record component.
    void
    build(EditSession editSession, BlockVector3 position, Pattern pattern, double size)
    Build the object.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    frequency()
    Returns the value of the frequency record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    Vector3
    radius()
    Returns the value of the radius 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

    • RockBrush

      public RockBrush(double amplitude, double frequency, Vector3 radius)
      Creates an instance of a RockBrush record class.
      Parameters:
      amplitude - the value for the amplitude record component
      frequency - the value for the frequency record component
      radius - the value for the radius record component

  • Method Details

    • build

      public void build(EditSession editSession, BlockVector3 position, Pattern pattern, double size) throws MaxChangedBlocksException
      Description copied from interface: Brush
      Build the object.
      Specified by:
      build in interface Brush
      Parameters:
      editSession - the EditSession
      position - the position
      pattern - the pattern
      size - the size of the brush
      Throws:
      MaxChangedBlocksException - if the maximum block change limit is exceeded

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

    • amplitude

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

    • frequency

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

    • radius

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