Package dev.jaxydog.astral.content.item.custom

Record Class Sprayed.SprayResult

java.lang.Object
java.lang.Record
dev.jaxydog.astral.content.item.custom.Sprayed.SprayResult
Record Components:
charges - The charges that should be consumed.
position - The position that the bottle was sprayed from.
actions - The actions that should be executed.
silent - Whether to skip playing the spray sound.
Enclosing interface:
Sprayed
public static record Sprayed.SprayResult(int charges, net.minecraft.util.math.Vec3d position, List<Runnable> actions, boolean silent) extends Record
The result of spraying an object.

If the result is valid, the accept(ItemStack, BiConsumer) method should be invoked.

Since:
2.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SprayResult(int charges, net.minecraft.util.math.Vec3d position, List<Runnable> actions, boolean silent)
    Creates an instance of a SprayResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(net.minecraft.item.ItemStack stack, BiConsumer<net.minecraft.item.ItemStack,Integer> consume)
    Executes the result's stored actions, consuming charges from the given stack.
    List<Runnable>
    actions()
    Returns the value of the actions record component.
    int
    charges()
    Returns the value of the charges 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.
    net.minecraft.util.math.Vec3d
    position()
    Returns the value of the position record component.
    boolean
    silent()
    Returns the value of the silent 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

    • SprayResult

      public SprayResult(int charges, net.minecraft.util.math.Vec3d position, List<Runnable> actions, boolean silent)
      Creates an instance of a SprayResult record class.
      Parameters:
      charges - the value for the charges record component
      position - the value for the position record component
      actions - the value for the actions record component
      silent - the value for the silent record component

  • Method Details

    • accept

      public void accept(net.minecraft.item.ItemStack stack, BiConsumer<net.minecraft.item.ItemStack,Integer> consume)
      Executes the result's stored actions, consuming charges from the given stack.
      Parameters:
      stack - The item stack.
      consume - The charge consumption method.

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

    • charges

      public int charges()
      Returns the value of the charges record component.
      Returns:
      the value of the charges record component

    • position

      public net.minecraft.util.math.Vec3d position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • actions

      public List<Runnable> actions()
      Returns the value of the actions record component.
      Returns:
      the value of the actions record component

    • silent

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