Package net.minestom.server.instance.block.rule

Record Class BlockPlacementRule.PlacementState

java.lang.Object
java.lang.Record
net.minestom.server.instance.block.rule.BlockPlacementRule.PlacementState
Enclosing class:
BlockPlacementRule
public static record BlockPlacementRule.PlacementState(Block.Getter instance, @NotNull Block block, @Nullable BlockFace blockFace, @NotNull Point placePosition, @Nullable Point cursorPosition, @Nullable Pos playerPosition, @Nullable ItemStack usedItemStack, boolean isPlayerShifting) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlacementState(Block.Getter instance, @NotNull Block block, @Nullable BlockFace blockFace, @NotNull Point placePosition, @Nullable Point cursorPosition, @Nullable Pos playerPosition, @Nullable ItemStack usedItemStack, boolean isPlayerShifting)
    Creates an instance of a PlacementState record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Block
    block()
    Returns the value of the block record component.
    @Nullable BlockFace
    blockFace()
    Returns the value of the blockFace record component.
    @Nullable Point
    cursorPosition()
    Returns the value of the cursorPosition 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.
    Block.Getter
    instance()
    Returns the value of the instance record component.
    boolean
    isPlayerShifting()
    Returns the value of the isPlayerShifting record component.
    @NotNull Point
    placePosition()
    Returns the value of the placePosition record component.
    @Nullable Pos
    playerPosition()
    Returns the value of the playerPosition record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable ItemStack
    usedItemStack()
    Returns the value of the usedItemStack record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlacementState

      public PlacementState(@NotNull Block.Getter instance, @NotNull @NotNull Block block, @Nullable @Nullable BlockFace blockFace, @NotNull @NotNull Point placePosition, @Nullable @Nullable Point cursorPosition, @Nullable @Nullable Pos playerPosition, @Nullable @Nullable ItemStack usedItemStack, boolean isPlayerShifting)
      Creates an instance of a PlacementState record class.
      Parameters:
      instance - the value for the instance record component
      block - the value for the block record component
      blockFace - the value for the blockFace record component
      placePosition - the value for the placePosition record component
      cursorPosition - the value for the cursorPosition record component
      playerPosition - the value for the playerPosition record component
      usedItemStack - the value for the usedItemStack record component
      isPlayerShifting - the value for the isPlayerShifting 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. 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.

    • instance

      @NotNull public Block.Getter instance()
      Returns the value of the instance record component.
      Returns:
      the value of the instance record component

    • block

      @NotNull public @NotNull Block block()
      Returns the value of the block record component.
      Returns:
      the value of the block record component

    • blockFace

      @Nullable public @Nullable BlockFace blockFace()
      Returns the value of the blockFace record component.
      Returns:
      the value of the blockFace record component

    • placePosition

      @NotNull public @NotNull Point placePosition()
      Returns the value of the placePosition record component.
      Returns:
      the value of the placePosition record component

    • cursorPosition

      @Nullable public @Nullable Point cursorPosition()
      Returns the value of the cursorPosition record component.
      Returns:
      the value of the cursorPosition record component

    • playerPosition

      @Nullable public @Nullable Pos playerPosition()
      Returns the value of the playerPosition record component.
      Returns:
      the value of the playerPosition record component

    • usedItemStack

      @Nullable public @Nullable ItemStack usedItemStack()
      Returns the value of the usedItemStack record component.
      Returns:
      the value of the usedItemStack record component

    • isPlayerShifting

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