Interface NBTComponent<C extends NBTComponent<C,​B>,​B extends NBTComponentBuilder<C,​B>>

  • All Superinterfaces:
    Buildable<C,​B>, BuildableComponent<C,​B>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>
    All Known Subinterfaces:
    BlockNBTComponent, EntityNBTComponent, StorageNBTComponent

    public interface NBTComponent<C extends NBTComponent<C,​B>,​B extends NBTComponentBuilder<C,​B>>
    extends BuildableComponent<C,​B>
    A component that can display NBT fetched from different locations, optionally trying to interpret the NBT as JSON using the net.kyori.adventure.text.serializer.gson.GsonComponentSerializer to convert the JSON to a Component. Sending interpreted NBT to the chat would be similar to using /tellraw.

    This component consists of:

    nbtPath
    a path to specify which parts of the nbt you want displayed(examples).
    interpret
    a boolean telling adventure if the fetched NBT value should be parsed as JSON

    This component is rendered serverside and can therefore receive platform-defined context. See the documentation for your respective platform for more info

    Since:
    4.0.0
    Since Minecraft:
    1.14
    • Method Detail

      • nbtPath

        @NotNull
        @NotNull String nbtPath()
        Gets the NBT path.
        Returns:
        the NBT path
        Since:
        4.0.0
      • nbtPath

        @Contract(pure=true)
        @NotNull
        C nbtPath​(@NotNull
                  @NotNull String nbtPath)
        Sets the NBT path.
        Parameters:
        nbtPath - the NBT path
        Returns:
        an NBT component
        Since:
        4.0.0
      • interpret

        boolean interpret()
        Gets if we should be interpreting.
        Returns:
        if we should be interpreting
        Since:
        4.0.0
      • interpret

        @Contract(pure=true)
        @NotNull
        C interpret​(boolean interpret)
        Sets if we should be interpreting.
        Parameters:
        interpret - if we should be interpreting.
        Returns:
        an NBT component
        Since:
        4.0.0
      • separator

        @Nullable
        @Nullable Component separator()
        Gets the separator.
        Returns:
        the separator
        Since:
        4.8.0
      • separator

        @NotNull
        C separator​(@Nullable
                    @Nullable ComponentLike separator)
        Sets the separator.
        Parameters:
        separator - the separator
        Returns:
        the separator
        Since:
        4.8.0