Package studio.mevera.imperat.help

Class VelocityStringHelpComponent

java.lang.Object
studio.mevera.imperat.command.tree.help.theme.HelpComponent<VelocitySource,String>
studio.mevera.imperat.command.tree.help.theme.StringHelpComponent<VelocitySource>
studio.mevera.imperat.help.VelocityStringHelpComponent
public class VelocityStringHelpComponent extends studio.mevera.imperat.command.tree.help.theme.StringHelpComponent<VelocitySource>
Velocity-specific implementation of string-based help components. This class provides simple text-based help messages for Velocity commands, supporting MiniMessage formatting for basic styling and colors.

Features:

  • Simple string-based help messages
  • MiniMessage format support for colors and basic styling
  • Automatic integration with VelocitySource messaging
  • Lightweight alternative to Adventure Component-based help

Usage Example:


 VelocityStringHelpComponent help = VelocityStringHelpComponent.of(
     "<yellow>Use /mycommand <player> - Teleport to a player</yellow>"
 );
Since:
2.1.0
See Also:

  • Field Summary

    Fields inherited from class studio.mevera.imperat.command.tree.help.theme.HelpComponent

    componentValue

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    VelocityStringHelpComponent(@NotNull String componentValue)
    Creates a new VelocityStringHelpComponent with the specified string content.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VelocityStringHelpComponent
    of(@NotNull String componentValue)
    Creates a new VelocityStringHelpComponent with the specified string content.

    Methods inherited from class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent

    append, appendText, repeat, send

    Methods inherited from class studio.mevera.imperat.command.tree.help.theme.HelpComponent

    append, appendParameterFormat, appendText, plainText

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VelocityStringHelpComponent

      protected VelocityStringHelpComponent(@NotNull @NotNull String componentValue)
      Creates a new VelocityStringHelpComponent with the specified string content.
      Parameters:
      componentValue - the string content to display as help (supports MiniMessage formatting)

  • Method Details

    • of

      public static VelocityStringHelpComponent of(@NotNull @NotNull String componentValue)
      Creates a new VelocityStringHelpComponent with the specified string content.
      Parameters:
      componentValue - the string content to display as help (supports MiniMessage formatting)
      Returns:
      a new VelocityStringHelpComponent instance