Package net.kyori.adventure.text

Interface ObjectComponent.SpriteContents

All Superinterfaces:
net.kyori.examination.Examinable, ObjectComponent.Contents
Enclosing interface:
ObjectComponent
public static interface ObjectComponent.SpriteContents extends ObjectComponent.Contents
A sprite contents.

Represents a sprite in an atlas, such as a block texture.

Since:
4.25.0
Since Minecraft:
1.21.9

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Key
    atlas()
    Gets the atlas key.
    default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>
    examinableProperties()
     
    @NotNull Key
    sprite()
    Gets the sprite key.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examine

  • Method Details

    • atlas

      @Nullable @Nullable Key atlas()
      Gets the atlas key.

      When null, the default atlas key is used by the client, currently minecraft:blocks.

      Returns:
      the atlas key or null
      Since:
      4.25.0

    • sprite

      @NotNull @NotNull Key sprite()
      Gets the sprite key.
      Returns:
      the sprite key
      Since:
      4.25.0

    • examinableProperties

      @NotNull default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
      Specified by:
      examinableProperties in interface net.kyori.examination.Examinable