Package net.kyori.adventure.text

Interface ObjectComponent.Contents

All Superinterfaces:
net.kyori.examination.Examinable
All Known Subinterfaces:
ObjectComponent.SpriteContents
Enclosing interface:
ObjectComponent
public static interface ObjectComponent.Contents extends net.kyori.examination.Examinable
An object component contents.
Since:
4.25.0

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static @NotNull ObjectComponent.SpriteContents
    sprite(@NotNull Key sprite)
    Creates a sprite contents with the given sprite and the default atlas.
    static @NotNull ObjectComponent.SpriteContents
    sprite(@Nullable Key atlas, @NotNull Key sprite)
    Creates a sprite contents with the given atlas and sprite.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examinableProperties, examine

  • Method Details

    • sprite

      @Contract(value="_, _ -> new", pure=true) @NotNull static @NotNull ObjectComponent.SpriteContents sprite(@Nullable @Nullable Key atlas, @NotNull @NotNull Key sprite)
      Creates a sprite contents with the given atlas and sprite.
      Parameters:
      atlas - the atlas
      sprite - the sprite
      Returns:
      a sprite contents
      Since:
      4.25.0

    • sprite

      @Contract(value="_ -> new", pure=true) @NotNull static @NotNull ObjectComponent.SpriteContents sprite(@NotNull @NotNull Key sprite)
      Creates a sprite contents with the given sprite and the default atlas.
      Parameters:
      sprite - the sprite
      Returns:
      a sprite contents
      Since:
      4.25.0