com.sk89q.worldedit.world.block.BaseBlock

All Implemented Interfaces:: TileEntityBlock, Pattern, BlockStateHolder<BaseBlock>, NbtValued

Direct Known Subclasses:: MobSpawnerBlock, SignBlock, SkullBlock

public class BaseBlock extends Object implements BlockStateHolder<BaseBlock>, TileEntityBlock

Represents a "snapshot" of a block with NBT Data.

An instance of this block contains all the information needed to accurately reproduce the block, provided that the instance was made correctly. In some implementations, it may not be possible to get a snapshot of blocks correctly, so, for example, the NBT data for a block may be missing.

Constructor Summary

Constructors

Modifier

Constructor

Description

protected

BaseBlock(BlockState blockState)

Construct a block with a state.

protected

BaseBlock(BlockState state, CompoundTag nbtData)

Construct a block with the given ID, data value and NBT data structure.
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object o)

Checks whether the type ID and data value are equal.

boolean

equalsFuzzy(BlockStateHolder<?> o)

Checks if the type is the same, and if the matched states are the same.

BlockType

getBlockType()

Get the block type.

CompoundTag

getNbtData()

Get the object's NBT data (tile entity data).

String

getNbtId()

Return the name of the title entity ID.

<V> V

getState(Property<V> property)

Gets the State for this Block.

Map<Property<?>,Object>

getStates()

Gets a map of state to state values.

int

hashCode()

boolean

hasNbtData()

Returns whether the block contains NBT data.

void

setNbtData(CompoundTag nbtData)

Set the object's NBT data (tile entity data).

BaseBlock

toBaseBlock()

Gets a BaseBlock from this BlockStateHolder.

BaseBlock

toBaseBlock(CompoundTag compoundTag)

Gets a BaseBlock from this BlockStateHolder.

BlockState

toImmutableState()

Returns an immutable BlockState from this BlockStateHolder.

String

toString()

<V> BaseBlock

with(Property<V> property, V value)

Returns a BlockState with the given state and value applied.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sk89q.worldedit.world.block.BlockStateHolder
applyBlock, getAsString

Methods inherited from interface com.sk89q.worldedit.function.pattern.Pattern
apply

Constructor Details
- BaseBlock
  
  protected BaseBlock(BlockState blockState)
  
  Construct a block with a state.
  
  Parameters:
  
  blockState - The blockstate
- BaseBlock
  
  protected BaseBlock(BlockState state, CompoundTag nbtData)
  
  Construct a block with the given ID, data value and NBT data structure.
  
  Parameters:
  
  state - The block state
  
  nbtData - NBT data, which must be provided
Method Details
- getStates
  
  public Map<Property<?>,Object> getStates()
  
  Gets a map of state to state values.
  
  Specified by:
  
  getStates in interface BlockStateHolder<BaseBlock>
  
  Returns:
  
  The state map
- getBlockType
  
  public BlockType getBlockType()
  
  Description copied from interface: BlockStateHolder
  
  Get the block type.
  
  Specified by:
  
  getBlockType in interface BlockStateHolder<BaseBlock>
  
  Returns:
  
  The type
- with
  
  public <V> BaseBlock with(Property<V> property, V value)
  
  Description copied from interface: BlockStateHolder
  
  Returns a BlockState with the given state and value applied.
  
  Specified by:
  
  with in interface BlockStateHolder<BaseBlock>
  
  Parameters:
  
  property - The state
  
  value - The value
  
  Returns:
  
  The modified state, or same if could not be applied
- getState
  
  public <V> V getState(Property<V> property)
  
  Gets the State for this Block.
  
  Specified by:
  
  getState in interface BlockStateHolder<BaseBlock>
  
  Parameters:
  
  property - The state to get the value for
  
  Returns:
  
  The state value
- hasNbtData
  
  public boolean hasNbtData()
  
  Description copied from interface: NbtValued
  
  Returns whether the block contains NBT data. NbtValued.getNbtData() must not return null if this method returns true.
  
  Specified by:
  
  hasNbtData in interface NbtValued
  
  Returns:
  
  true if there is NBT data
- getNbtId
  
  public String getNbtId()
  
  Description copied from interface: TileEntityBlock
  
  Return the name of the title entity ID.
  
  Specified by:
  
  getNbtId in interface TileEntityBlock
  
  Returns:
  
  tile entity ID, non-null string
- getNbtData
  
  @Nullable public CompoundTag getNbtData()
  
  Description copied from interface: NbtValued
  
  Get the object's NBT data (tile entity data). The returned tag, if modified in any way, should be sent to NbtValued.setNbtData(CompoundTag) so that the instance knows of the changes. Making changes without calling NbtValued.setNbtData(CompoundTag) could have unintended consequences.
  NbtValued.hasNbtData() must return true if and only if method does not return null.
  
  Specified by:
  
  getNbtData in interface NbtValued
  
  Returns:
  
  compound tag, or null
- setNbtData
  
  public void setNbtData(@Nullable CompoundTag nbtData)
  
  Description copied from interface: NbtValued
  
  Set the object's NBT data (tile entity data).
  
  Specified by:
  
  setNbtData in interface NbtValued
  
  Parameters:
  
  nbtData - NBT data, or null if no data
- equals
  
  public boolean equals(Object o)
  
  Checks whether the type ID and data value are equal.
  
  Overrides:
  
  equals in class Object
- equalsFuzzy
  
  public boolean equalsFuzzy(BlockStateHolder<?> o)
  
  Checks if the type is the same, and if the matched states are the same.
  
  Specified by:
  
  equalsFuzzy in interface BlockStateHolder<BaseBlock>
  
  Parameters:
  
  o - other block
  
  Returns:
  
  true if equal
- toImmutableState
  
  public BlockState toImmutableState()
  
  Description copied from interface: BlockStateHolder
  
  Returns an immutable BlockState from this BlockStateHolder.
  
  Specified by:
  
  toImmutableState in interface BlockStateHolder<BaseBlock>
  
  Returns:
  
  A BlockState
- toBaseBlock
  
  public BaseBlock toBaseBlock()
  
  Description copied from interface: BlockStateHolder
  
  Gets a BaseBlock from this BlockStateHolder.
  
  Specified by:
  
  toBaseBlock in interface BlockStateHolder<BaseBlock>
  
  Returns:
  
  The BaseBlock
- toBaseBlock
  
  public BaseBlock toBaseBlock(CompoundTag compoundTag)
  
  Description copied from interface: BlockStateHolder
  
  Gets a BaseBlock from this BlockStateHolder.
  
  Specified by:
  
  toBaseBlock in interface BlockStateHolder<BaseBlock>
  
  Parameters:
  
  compoundTag - The NBT Data to apply
  
  Returns:
  
  The BaseBlock
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class BaseBlock

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.sk89q.worldedit.world.block.BlockStateHolder

Methods inherited from interface com.sk89q.worldedit.function.pattern.Pattern

Constructor Details

BaseBlock

BaseBlock

Method Details

getStates

getBlockType

with

getState

hasNbtData

getNbtId

getNbtData

setNbtData

equals

equalsFuzzy

toImmutableState

toBaseBlock

toBaseBlock

hashCode

toString