Package dan200.computercraft.api.detail

Record Class BlockReference

java.lang.Object
java.lang.Record
dan200.computercraft.api.detail.BlockReference
Record Components:
level - The level the block exists in.
pos - The position of the block.
state - The block state at this position.
blockEntity - The block entity at this position, if it exists.
public record BlockReference(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState state, @Nullable net.minecraft.world.level.block.entity.BlockEntity blockEntity) extends Record
A reference to a block in the world, used by block detail providers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlockReference(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos)
     
    BlockReference(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState state, @Nullable net.minecraft.world.level.block.entity.BlockEntity blockEntity)
    Creates an instance of a BlockReference record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable net.minecraft.world.level.block.entity.BlockEntity
    blockEntity()
    Returns the value of the blockEntity 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.world.level.Level
    level()
    Returns the value of the level record component.
    net.minecraft.core.BlockPos
    pos()
    Returns the value of the pos record component.
    net.minecraft.world.level.block.state.BlockState
    state()
    Returns the value of the state 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

    • BlockReference

      public BlockReference(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos)

    • BlockReference

      public BlockReference(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState state, @Nullable net.minecraft.world.level.block.entity.BlockEntity blockEntity)
      Creates an instance of a BlockReference record class.
      Parameters:
      level - the value for the level record component
      pos - the value for the pos record component
      state - the value for the state record component
      blockEntity - the value for the blockEntity 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • level

      public net.minecraft.world.level.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component

    • pos

      public net.minecraft.core.BlockPos pos()
      Returns the value of the pos record component.
      Returns:
      the value of the pos record component

    • state

      public net.minecraft.world.level.block.state.BlockState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • blockEntity

      public @Nullable net.minecraft.world.level.block.entity.BlockEntity blockEntity()
      Returns the value of the blockEntity record component.
      Returns:
      the value of the blockEntity record component