Package com.sk89q.worldedit.world

Interface NbtValued

All Known Subinterfaces:
BlockStateHolder<B>, TileEntityBlock
All Known Implementing Classes:
AbstractExtentFilterBlock, AbstractFilterBlock, AbstractSingleFilterBlock, ArrayFilterBlock, BaseBlock, BaseEntity, BaseItem, BaseItemStack, BlanketBaseBlock, BlockState, CharFilterBlock, ChunkFilterBlock, ExtentFilterBlock, FilterBlock, FuzzyBlockState, LazyBaseEntity, LegacyBaseBlockWrapper, MobSpawnerBlock, SignBlock, SingleFilterBlock, SkullBlock, VectorizedCharFilterBlock
public interface NbtValued
Indicates an object that contains extra data identified as an NBT structure. This interface is used when saving and loading objects to a serialized format, but may be used in other cases.

  • Method Details Link icon

    • hasNbtData Link icon

      @Deprecated default boolean hasNbtData()
      Deprecated.
      See getNbt()
      Returns whether the block contains NBT data. getNbtData() must not return null if this method returns true.
      Returns:
      true if there is NBT data

    • getNbtData Link icon

      @Deprecated @Nullable default CompoundTag getNbtData()
      Deprecated.
      See getNbt()
      Get the object's NBT data (tile entity data). The returned tag, if modified in any way, should be sent to setNbtData(CompoundTag) so that the instance knows of the changes. Making changes without calling setNbtData(CompoundTag) could have unintended consequences.

      hasNbtData() must return true if and only if method does not return null.

      Returns:
      compound tag, or null

    • setNbtData Link icon

      @Deprecated default void setNbtData(@Nullable CompoundTag nbtData)
      Deprecated.
      See setNbtReference(LazyReference)
      Set the object's NBT data (tile entity data).
      Parameters:
      nbtData - NBT data, or null if no data

    • getNbtReference Link icon

      @NonAbstractForCompatibility(delegateName="getNbtData", delegateParams={}) @Nullable default LazyReference<org.enginehub.linbus.tree.LinCompoundTag> getNbtReference()
      Get the object's NBT data (tile entity data).

      This only needs to be used if you don't want to immediately resolve the data. Otherwise, you probably want getNbt().

      Returns:
      compound tag, or null

    • getNbt Link icon

      @Nullable default org.enginehub.linbus.tree.LinCompoundTag getNbt()
      Get the object's NBT data (tile entity data).
      Returns:
      compound tag, or null

    • setNbtReference Link icon

      @NonAbstractForCompatibility(delegateName="setNbtData", delegateParams=CompoundTag.class) default void setNbtReference(@Nullable LazyReference<org.enginehub.linbus.tree.LinCompoundTag> nbtData)
      Set the object's NBT data (tile entity data).
      Parameters:
      nbtData - NBT data, or null if no data

    • setNbt Link icon

      default void setNbt(@Nullable org.enginehub.linbus.tree.LinCompoundTag nbtData)
      Set the object's NBT data (tile entity data).
      Parameters:
      nbtData - NBT data, or null if no data