Package com.github.darksoulq.abyssallib.world.structure

Record Class Structure.StructureBlock

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.structure.Structure.StructureBlock
Record Components:
pos - The relative vector offset.
stateIndex - The pointer index resolving to a definition inside the structure palette.
properties - Extra custom NBT-like properties bound directly to the block logic.
nbt - Standard vanilla tile-entity data (nullable).
Enclosing class:
Structure
public static record Structure.StructureBlock(org.bukkit.util.Vector pos, int stateIndex, @Nullable Object properties, @Nullable Object nbt) extends Record
A structural marker indicating the position and index configuration of a discrete block.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StructureBlock(org.bukkit.util.Vector pos, int stateIndex, @Nullable Object properties, @Nullable Object nbt)
    Creates an instance of a StructureBlock record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    @Nullable Object
    nbt()
    Returns the value of the nbt record component.
    org.bukkit.util.Vector
    pos()
    Returns the value of the pos record component.
    @Nullable Object
    properties()
    Returns the value of the properties record component.
    int
    stateIndex()
    Returns the value of the stateIndex record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • StructureBlock

      public StructureBlock(org.bukkit.util.Vector pos, int stateIndex, @Nullable @Nullable Object properties, @Nullable @Nullable Object nbt)
      Creates an instance of a StructureBlock record class.
      Parameters:
      pos - the value for the pos record component
      stateIndex - the value for the stateIndex record component
      properties - the value for the properties record component
      nbt - the value for the nbt 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.

    • pos

      public org.bukkit.util.Vector pos()
      Returns the value of the pos record component.
      Returns:
      the value of the pos record component

    • stateIndex

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

    • properties

      @Nullable public @Nullable Object properties()
      Returns the value of the properties record component.
      Returns:
      the value of the properties record component

    • nbt

      @Nullable public @Nullable Object nbt()
      Returns the value of the nbt record component.
      Returns:
      the value of the nbt record component