Package com.kamikazejam.kamicommon.nms.abstraction.chat.impl

Class KMessageBlock

java.lang.Object
com.kamikazejam.kamicommon.nms.abstraction.chat.KMessage
com.kamikazejam.kamicommon.nms.abstraction.chat.impl.KMessageBlock
public class KMessageBlock extends KMessage
Implementation of KMessage for multi-line interactive messages.

This class represents a message consisting of multiple lines of text with optional interactive actions. It provides methods for adding lines dynamically and includes static factory methods for creating common types of interactive multi-line messages such as clickable commands, hover text, and URL links.

The class supports method chaining for fluent message construction and handles line management for complex multi-line displays like help text, menus, or information panels.

  • Constructor Details

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull String line)
      Creates a new multi-line message with a single initial line.
      Parameters:
      line - the initial line of text for the message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull String... lines)
      Creates a new multi-line message with the specified lines.

      Note: This constructor converts the varargs array to a string representation and adds it as a single line. For multiple separate lines, use the List constructor instead.

      Parameters:
      lines - the lines to include in the message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull List<String> lines)
      Creates a new multi-line message with the specified list of lines.
      Parameters:
      lines - the list of text lines for the message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull String line, @NotNull @NotNull Action... actions)
      Creates a new multi-line message with a single line and actions.
      Parameters:
      line - the initial line of text for the message
      actions - the Action instances to attach to this message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull String line, @NotNull @NotNull List<Action> actions)
      Creates a new multi-line message with a single line and action list.
      Parameters:
      line - the initial line of text for the message
      actions - the list of Action instances to attach to this message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull List<String> lines, @NotNull @NotNull Action... actions)
      Creates a new multi-line message with the specified lines and actions.
      Parameters:
      lines - the list of text lines for the message
      actions - the Action instances to attach to this message

    • KMessageBlock

      public KMessageBlock(@NotNull @NotNull List<String> lines, @NotNull @NotNull List<Action> actions)
      Creates a new multi-line message with the specified lines and action list.
      Parameters:
      lines - the list of text lines for the message
      actions - the list of Action instances to attach to this message

  • Method Details

    • addLine

      @NotNull public @NotNull KMessageBlock addLine(@NotNull @NotNull String line)
      Adds a new line to this multi-line message.

      This method appends the specified line to the end of the current line list. This is useful for building up message content dynamically or adding lines based on runtime conditions.

      Parameters:
      line - the text line to add to this message
      Returns:
      this KMessageBlock instance for method chaining

    • getLines

      @NotNull public @NotNull List<String> getLines()
      Retrieves the lines of text that make up this message.

      This abstract method must be implemented by subclasses to define how the message content is structured. For single-line messages, this returns a list with one element. For multi-line messages, this returns all lines in order.

      For multi-line messages, this returns the complete list of lines that make up this message block.

      Specified by:
      getLines in class KMessage
      Returns:
      the list of text lines that make up this message

    • ofClickRunCommand

      @NotNull public static @NotNull KMessageBlock ofClickRunCommand(@NotNull @NotNull String line, @NotNull @NotNull String command)
      Creates a multi-line message that executes a command when clicked.

      This factory method creates a message where the entire content is clickable and executes the specified command when clicked by the player. The command will be run as if the player typed it in chat.

      Parameters:
      line - the text content to display and make clickable
      command - the command to execute when clicked (without leading slash)
      Returns:
      a new KMessageBlock with the click action configured

    • ofClickSuggestCommand

      @NotNull public static @NotNull KMessageBlock ofClickSuggestCommand(@NotNull @NotNull String line, @NotNull @NotNull String suggestion)
      Creates a multi-line message that suggests a command when clicked.

      This factory method creates a message where the entire content is clickable and suggests the specified command in the player's chat input when clicked. The player can then modify or execute the suggested command.

      Parameters:
      line - the text content to display and make clickable
      suggestion - the command to suggest when clicked (without leading slash)
      Returns:
      a new KMessageBlock with the click suggestion configured

    • ofClickOpenURL

      @NotNull public static @NotNull KMessageBlock ofClickOpenURL(@NotNull @NotNull String line, @NotNull @NotNull String url)
      Creates a multi-line message that opens a URL when clicked.

      This factory method creates a message where the entire content is clickable and opens the specified URL in the player's default web browser when clicked.

      Parameters:
      line - the text content to display and make clickable
      url - the URL to open when clicked
      Returns:
      a new KMessageBlock with the URL click action configured

    • ofHoverText

      @NotNull public static @NotNull KMessageBlock ofHoverText(@NotNull @NotNull String line, @NotNull @NotNull String text)
      Creates a multi-line message with hover text.

      This factory method creates a message where the entire content shows custom hover text when the player hovers their cursor over it.

      Parameters:
      line - the text content to display and make hoverable
      text - the text to show in the hover tooltip
      Returns:
      a new KMessageBlock with the hover text configured

    • ofHoverItem

      @NotNull public static @NotNull KMessageBlock ofHoverItem(@NotNull @NotNull String line, @NotNull @NotNull ItemStack item)
      Creates a multi-line message with hover item display.

      This factory method creates a message where the entire content shows an item tooltip when the player hovers their cursor over it.

      Parameters:
      line - the text content to display and make hoverable
      item - the ItemStack to show in the hover tooltip
      Returns:
      a new KMessageBlock with the hover item configured