Package cloud.commandframework.minecraft.extras

Class MinecraftHelp.HelpColors

java.lang.Object
cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors
Enclosing class:
MinecraftHelp<C>
public static final class MinecraftHelp.HelpColors extends Object
Class for holding the TextColors used for help menus

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull net.kyori.adventure.text.format.TextColor
    accent()
    Get the configured accent color
    @NonNull net.kyori.adventure.text.format.TextColor
    alternateHighlight()
    Get the configured alternate highlight color
    @NonNull net.kyori.adventure.text.format.TextColor
    highlight()
    Get the configured highlight color
    static @NonNull MinecraftHelp.HelpColors
    of(@NonNull net.kyori.adventure.text.format.TextColor primary, @NonNull net.kyori.adventure.text.format.TextColor highlight, @NonNull net.kyori.adventure.text.format.TextColor alternateHighlight, @NonNull net.kyori.adventure.text.format.TextColor text, @NonNull net.kyori.adventure.text.format.TextColor accent)
    Create a new MinecraftHelp.HelpColors instance
    @NonNull net.kyori.adventure.text.format.TextColor
    primary()
    Get the configured primary color
    @NonNull net.kyori.adventure.text.format.TextColor
    text()
    Get the configured text color

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • primary

      public @NonNull net.kyori.adventure.text.format.TextColor primary()
      Get the configured primary color
      Returns:
      The primary color for the color scheme

    • highlight

      public @NonNull net.kyori.adventure.text.format.TextColor highlight()
      Get the configured highlight color
      Returns:
      The primary color used to highlight commands and queries

    • alternateHighlight

      public @NonNull net.kyori.adventure.text.format.TextColor alternateHighlight()
      Get the configured alternate highlight color
      Returns:
      The secondary color used to highlight commands and queries

    • text

      public @NonNull net.kyori.adventure.text.format.TextColor text()
      Get the configured text color
      Returns:
      The color used for description text

    • accent

      public @NonNull net.kyori.adventure.text.format.TextColor accent()
      Get the configured accent color
      Returns:
      The color used for accents and symbols

    • of

      public static @NonNull MinecraftHelp.HelpColors of(@NonNull net.kyori.adventure.text.format.TextColor primary, @NonNull net.kyori.adventure.text.format.TextColor highlight, @NonNull net.kyori.adventure.text.format.TextColor alternateHighlight, @NonNull net.kyori.adventure.text.format.TextColor text, @NonNull net.kyori.adventure.text.format.TextColor accent)
      Create a new MinecraftHelp.HelpColors instance
      Parameters:
      primary - The primary color for the color scheme
      highlight - The primary color used to highlight commands and queries
      alternateHighlight - The secondary color used to highlight commands and queries
      text - The color used for description text
      accent - The color used for accents and symbols
      Returns:
      A new MinecraftHelp.HelpColors instance