Package dev.jorel.commandapi

Class BukkitStringTooltip

java.lang.Object

dev.jorel.commandapi.StringTooltip

dev.jorel.commandapi.BukkitStringTooltip

All Implemented Interfaces:

IStringTooltip

public class BukkitStringTooltip
extends StringTooltip

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BukkitStringTooltip(String suggestion, com.mojang.brigadier.Message tooltip)

Method Summary

Modifier and Type	Method	Description
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
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
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
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
static StringTooltip	ofAdventureComponent(String suggestion, net.kyori.adventure.text.Component tooltip)	Constructs a StringTooltip with a suggestion and a formatted adventure text component tooltip
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

Methods inherited from class dev.jorel.commandapi.StringTooltip

generate, generate, generate, generateMessages, generateMessages, generateStrings, generateStrings, getSuggestion, getTooltip, none, none, none, ofMessage, ofString

Methods inherited from class java.lang.Object

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

Constructor Details

BukkitStringTooltip

protected BukkitStringTooltip(String suggestion,
 com.mojang.brigadier.Message tooltip)

Method Details

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

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