Package net.kyori.adventure.text.event

Interface DataComponentValue

All Superinterfaces:
net.kyori.examination.Examinable
All Known Subinterfaces:
BinaryTagHolder, DataComponentValue.Removed, DataComponentValue.TagSerializable
public interface DataComponentValue extends net.kyori.examination.Examinable
A holder for the value of an item's data component.

The exact value is platform-specific. Serializers may provide their own implementations as well, and any logic to serialize or deserialize should be done per-serializer.

Since:
4.17.0
Since Minecraft:
1.20.5

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    DataComponentValue.Removed
    Only valid in a patch-style usage, indicating that the data component with a certain key should be removed.
    static interface 
    DataComponentValue.TagSerializable
    Represent an DataComponentValue that can be represented as a binary tag.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static @NotNull DataComponentValue.Removed
    removed()
    Get a marker value to indicate that a data component's value should be removed.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examinableProperties, examine

  • Method Details

    • removed

      static @NotNull DataComponentValue.Removed removed()
      Get a marker value to indicate that a data component's value should be removed.
      Returns:
      the removed holder
      Since:
      4.17.0
      Since Minecraft:
      1.20.5