Package dev.jorel.commandapi

Class StringTooltip

java.lang.Object
dev.jorel.commandapi.StringTooltip
All Implemented Interfaces:
IStringTooltip
public class StringTooltip extends Object implements IStringTooltip
Represents a suggestion for an argument with a hover tooltip text for that suggestion. This class is to be used with normal suggestion overrides, via the Argument.overrideSuggestionsT method.

  • Method Details

    • of

      @Deprecated(forRemoval=true) public static StringTooltip of(String suggestion, String tooltip)
      Deprecated, for removal: This API element is subject to removal in a future version.
      please use ofString(String, String) instead
      Constructs a StringTooltip with a suggestion and a string tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      tooltip - the string tooltip to show to the user when they hover over the suggestion
      Returns:
      a StringTooltip representing this suggestion and tooltip

    • ofString

      public static StringTooltip ofString(String suggestion, String tooltip)
      Constructs a StringTooltip with a suggestion and a string tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      tooltip - the string tooltip to show to the user when they hover over the suggestion
      Returns:
      a StringTooltip representing this suggestion and tooltip

    • ofMessage

      public static StringTooltip ofMessage(String suggestion, com.mojang.brigadier.Message tooltip)
      Constructs a StringTooltip with a suggestion and a formatted tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      tooltip - the formatted tooltip to show to the user when they hover over the suggestion
      Returns:
      a StringTooltip representing this suggestion and tooltip

    • ofBaseComponents

      public static StringTooltip ofBaseComponents(String suggestion, net.md_5.bungee.api.chat.BaseComponent... tooltip)
      Constructs a StringTooltip with a suggestion and a formatted bungee text component tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      tooltip - the formatted tooltip to show to the user when they hover over the suggestion
      Returns:
      a StringTooltip representing this suggestion and tooltip

    • ofAdventureComponent

      public static StringTooltip ofAdventureComponent(String suggestion, net.kyori.adventure.text.Component tooltip)
      Constructs a StringTooltip with a suggestion and a formatted adventure text component tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      tooltip - the formatted tooltip to show to the user when they hover over the suggestion
      Returns:
      a StringTooltip representing this suggestion and tooltip

    • none

      public static StringTooltip none(String suggestion)
      Constructs a StringTooltip with a suggestion and no tooltip
      Parameters:
      suggestion - the suggestion to provide to the user
      Returns:
      a StringTooltip representing this suggestion

    • none

      public static Collection<StringTooltip> none(String... suggestions)
      Constructs a collection of StringTooltip objects from an array of suggestions, and no tooltips
      Parameters:
      suggestions - array of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the suggestions, with no tooltips

    • none

      public static Collection<StringTooltip> none(Collection<String> suggestions)
      Constructs a collection of StringTooltip objects from a collection of suggestions, and no tooltips
      Parameters:
      suggestions - collection of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the suggestions, with no tooltips

    • generateStrings

      public static Collection<StringTooltip> generateStrings(Function<String,String> tooltipGenerator, String... suggestions)
      Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a string tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a string tooltip for the suggestion
      suggestions - array of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated string tooltips

    • generateStrings

      public static Collection<StringTooltip> generateStrings(Function<String,String> tooltipGenerator, Collection<String> suggestions)
      Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a string tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a string tooltip for the suggestion
      suggestions - collection of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated string tooltips

    • generateMessages

      public static Collection<StringTooltip> generateMessages(Function<String,com.mojang.brigadier.Message> tooltipGenerator, String... suggestions)
      Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a formatted tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion
      suggestions - array of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • generateMessages

      public static Collection<StringTooltip> generateMessages(Function<String,com.mojang.brigadier.Message> tooltipGenerator, Collection<String> suggestions)
      Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a formatted tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion
      suggestions - collection of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • generateBaseComponents

      public static Collection<StringTooltip> generateBaseComponents(Function<String,net.md_5.bungee.api.chat.BaseComponent[]> tooltipGenerator, String... suggestions)
      Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a formatted tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion, an array of BaseComponents
      suggestions - array of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • generateBaseComponents

      public static Collection<StringTooltip> generateBaseComponents(Function<String,net.md_5.bungee.api.chat.BaseComponent[]> tooltipGenerator, Collection<String> suggestions)
      Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a formatted tooltip for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion, an array of BaseComponents
      suggestions - collection of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • generateAdventureComponents

      public static Collection<StringTooltip> generateAdventureComponents(Function<String,net.kyori.adventure.text.Component> tooltipGenerator, String... suggestions)
      Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a tooltip formatted as an adventure Component for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion, an adventure Component
      suggestions - array of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • generateAdventureComponents

      public static Collection<StringTooltip> generateAdventureComponents(Function<String,net.kyori.adventure.text.Component> tooltipGenerator, Collection<String> suggestions)
      Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a tooltip formatted as an adventure Component for each suggestion
      Parameters:
      tooltipGenerator - function which returns a formatted tooltip for the suggestion, an adventure Component
      suggestions - collection of suggestions to provide to the user
      Returns:
      a collection of StringTooltip objects from the provided suggestions, with the generated formatted tooltips

    • getSuggestion

      public String getSuggestion()
      Returns the current suggestion that this class holds
      Specified by:
      getSuggestion in interface IStringTooltip
      Returns:
      the current suggestion that this class holds

    • getTooltip

      public com.mojang.brigadier.Message getTooltip()
      Returns the current tooltip text that this class holds
      Specified by:
      getTooltip in interface IStringTooltip
      Returns:
      the current tooltip text that this class holds