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
    • Field Detail

      • DEFAULT_TIMES

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

      • title

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

        @NotNull
        static @NotNull Title title​(@NotNull
                                    @NotNull Component title,
                                    @NotNull
                                    @NotNull Component subtitle,
                                    @Nullable
                                    @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

        @NotNull
        @NotNull Component title()
        Gets the title.
        Returns:
        the title
        Since:
        4.0.0
      • subtitle

        @NotNull
        @NotNull Component subtitle()
        Gets the subtitle.
        Returns:
        the subtitle
        Since:
        4.0.0
      • times

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

        <T> @UnknownNullability T part​(@NotNull
                                       @NotNull TitlePart<T> part)
        Gets a part.
        Type Parameters:
        T - the type of the part
        Parameters:
        part - the part
        Returns:
        the value
        Since:
        4.9.0