Record Class GraphInstructions

java.lang.Object
java.lang.Record
com.soulfiremc.server.pathfinding.graph.GraphInstructions
public record GraphInstructions(SFVec3i blockPosition, int deltaUsableBlockItems, boolean requiresOneBlock, ActionDirection moveDirection, double actionCost, List<WorldAction> actions) extends Record

  • Constructor Details

    • GraphInstructions

      public GraphInstructions(SFVec3i blockPosition, int deltaUsableBlockItems, boolean requiresOneBlock, ActionDirection moveDirection, double actionCost, List<WorldAction> actions)
      Creates an instance of a GraphInstructions record class.
      Parameters:
      blockPosition - the value for the blockPosition record component
      deltaUsableBlockItems - the value for the deltaUsableBlockItems record component
      requiresOneBlock - the value for the requiresOneBlock record component
      moveDirection - the value for the moveDirection record component
      actionCost - the value for the actionCost record component
      actions - the value for the actions record component

  • Method Details

    • withBlockPosition

      @NotNull public @NotNull GraphInstructions withBlockPosition(SFVec3i blockPosition)
      Returns:
      this.

    • withDeltaUsableBlockItems

      @NotNull public @NotNull GraphInstructions withDeltaUsableBlockItems(int deltaUsableBlockItems)
      Returns:
      this.

    • withRequiresOneBlock

      @NotNull public @NotNull GraphInstructions withRequiresOneBlock(boolean requiresOneBlock)
      Returns:
      this.

    • withMoveDirection

      @NotNull public @NotNull GraphInstructions withMoveDirection(ActionDirection moveDirection)
      Returns:
      this.

    • withActionCost

      @NotNull public @NotNull GraphInstructions withActionCost(double actionCost)
      Returns:
      this.

    • withActions

      @NotNull public @NotNull GraphInstructions withActions(List<WorldAction> actions)
      Returns:
      this.

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • blockPosition

      public SFVec3i blockPosition()
      Returns the value of the blockPosition record component.
      Returns:
      the value of the blockPosition record component

    • deltaUsableBlockItems

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

    • requiresOneBlock

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

    • moveDirection

      public ActionDirection moveDirection()
      Returns the value of the moveDirection record component.
      Returns:
      the value of the moveDirection record component

    • actionCost

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

    • actions

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