Package dev.itsharshxd.zentrix.api.block

Record Class TrackedBlockState

java.lang.Object
java.lang.Record
dev.itsharshxd.zentrix.api.block.TrackedBlockState
public record TrackedBlockState(@NotNull BlockMechanicsScope scope, boolean protectionEnabled, boolean originalProtected, boolean playerPlaced, boolean fluidTracked, boolean decayScheduled) extends Record
Current protection and decay classification of one block.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TrackedBlockState(@NotNull BlockMechanicsScope scope, boolean protectionEnabled, boolean originalProtected, boolean playerPlaced, boolean fluidTracked, boolean decayScheduled)
    Creates an instance of a TrackedBlockState record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    decayScheduled()
    Returns the value of the decayScheduled record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    fluidTracked()
    Returns the value of the fluidTracked record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    originalProtected()
    Returns the value of the originalProtected record component.
    boolean
    playerPlaced()
    Returns the value of the playerPlaced record component.
    boolean
    protectionEnabled()
    Returns the value of the protectionEnabled record component.
    @NotNull BlockMechanicsScope
    scope()
    Returns the value of the scope 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

    • TrackedBlockState

      public TrackedBlockState(@NotNull @NotNull BlockMechanicsScope scope, boolean protectionEnabled, boolean originalProtected, boolean playerPlaced, boolean fluidTracked, boolean decayScheduled)
      Creates an instance of a TrackedBlockState record class.
      Parameters:
      scope - the value for the scope record component
      protectionEnabled - the value for the protectionEnabled record component
      originalProtected - the value for the originalProtected record component
      playerPlaced - the value for the playerPlaced record component
      fluidTracked - the value for the fluidTracked record component
      decayScheduled - the value for the decayScheduled 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.

    • scope

      @NotNull public @NotNull BlockMechanicsScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • protectionEnabled

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

    • originalProtected

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

    • playerPlaced

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

    • fluidTracked

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

    • decayScheduled

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