Package dev.majek.hexnicks.message

Interface MiniMessageWrapper

public interface MiniMessageWrapper
A wrapper for MiniMessage to add a few more methods for more customization.
Since:
2.1.2

  • Method Details

    • standard

      @NotNull static @NotNull MiniMessageWrapper standard()

      Gets a simple instance.

      This will parse everything like MiniMessage will except for advanced transformations.

      Builder options with this instance:

      • Gradients: True
      • Hex Colors: True
      • Standard Colors: True
      • Legacy Colors: False
      • Advanced Transformations: False
      Returns:
      a simple instance
      Since:
      2.1.2

    • legacy

      @NotNull static @NotNull MiniMessageWrapper legacy()

      Gets a simple instance with legacy code support.

      This will parse everything like MiniMessage will with the addition of legacy code support and the subtraction of advanced transformation support.

      Builder options with this instance:

      • Gradients: True
      • Hex Colors: True
      • Standard Colors: True
      • Legacy Colors: True
      • Advanced Transformations: False
      Returns:
      a simple instance
      Since:
      2.1.2

    • mmParse

      @NotNull @NotNull net.kyori.adventure.text.Component mmParse(@NotNull @NotNull String mmString)
      Parse a string into a Component using MiniMessage.
      Parameters:
      mmString - the string to parse
      Returns:
      component
      Since:
      2.1.2

    • mmString

      @NotNull @NotNull String mmString(@NotNull @NotNull String mmString)
      Get the modified string.
      Parameters:
      mmString - string to modify
      Returns:
      modified string
      Since:
      2.1.2

    • builder

      @NotNull static @NotNull MiniMessageWrapper.Builder builder()

      Creates a new MiniMessageWrapper.Builder.

      Default builder options:

      • Gradients: True
      • Hex Colors: True
      • Standard Colors: True
      • Legacy Colors: False
      • Advanced Transformations: False
      Returns:
      a builder
      Since:
      2.1.2

    • toBuilder

      @NotNull @NotNull MiniMessageWrapper.Builder toBuilder()
      Create a MiniMessageWrapper.Builder to modify options.
      Returns:
      a builder
      Since:
      2.1.2