Package net.kyori.adventure.title

Interface Title

All Superinterfaces:
net.kyori.examination.Examinable
@NonExtendable
public interface Title
extends net.kyori.examination.Examinable
Represents an in-game title, which can be displayed across the centre of the screen.
Since:
4.0.0
See Also:
Title.Times

  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static interface  Title.Times
    Title times.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Title.Times DEFAULT_TIMES
    The default times.

  • Method Summary

    Modifier and Type Method Description
    @NonNull Component subtitle()
    Gets the subtitle.
    @Nullable Title.Times times()
    Gets the times.
    @NonNull Component title()
    Gets the title.
    static @NonNull Title title​(@NonNull Component title, @NonNull Component subtitle)
    Creates a title.
    static @NonNull Title title​(@NonNull Component title, @NonNull Component subtitle, @Nullable Title.Times times)
    Creates a title.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examinableProperties, examine

  • Field Details

    • DEFAULT_TIMES

      static final Title.Times DEFAULT_TIMES
      The default times.
      Since:
      4.0.0

  • Method Details

    • title

      static @NonNull Title title​(@NonNull Component title, @NonNull Component subtitle)
      Creates a title.
      Parameters:
      title - the title
      subtitle - the subtitle
      Returns:
      the title
      Since:
      4.0.0

    • title

      static @NonNull Title title​(@NonNull Component title, @NonNull Component subtitle, @Nullable Title.Times times)
      Creates a title.
      Parameters:
      title - the title
      subtitle - the subtitle
      times - the times
      Returns:
      the title
      Since:
      4.0.0

    • title

      @NonNull Component title()
      Gets the title.
      Returns:
      the title
      Since:
      4.0.0

    • subtitle

      @NonNull Component subtitle()
      Gets the subtitle.
      Returns:
      the subtitle
      Since:
      4.0.0

    • times

      @Nullable Title.Times times()
      Gets the times.
      Returns:
      the times
      Since:
      4.0.0