Index

A B C D E F G H I L M P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

ADVANCED_FORMATTING - Enum constant in enum de.themoep.minedown.adventure.MineDownParser.Option
Translate advanced MineDown formatting (e.g.
applyFormat(ComponentBuilder, Collection<TextDecoration>) - Static method in class de.themoep.minedown.adventure.Util
applyFormat(ComponentBuilder, Map<TextDecoration, Boolean>) - Static method in class de.themoep.minedown.adventure.Util
Apply a collection of colors/formats to a component builder
applyFormat(Component, Collection<TextDecoration>) - Static method in class de.themoep.minedown.adventure.Util
Apply a collection of colors/formats to a component
autoAddUrlPrefix() - Method in class de.themoep.minedown.adventure.MineDownParser
Get whether or not to automatically add http to values of open_url when there doesn't exist any?
autoAddUrlPrefix(boolean) - Method in class de.themoep.minedown.adventure.MineDown
Automatically add http to values of open_url when there doesn't exist any? (Default: true)
autoAddUrlPrefix(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
Set whether or not to automatically add http to values of open_url when there doesn't exist any?

B

builder() - Method in class de.themoep.minedown.adventure.MineDownParser
 
builder(ComponentBuilder) - Method in class de.themoep.minedown.adventure.MineDownParser
 

C

clickEvent() - Method in class de.themoep.minedown.adventure.MineDownParser
 
clickEvent(ClickEvent) - Method in class de.themoep.minedown.adventure.MineDownParser
 
COLOR_PREFIX - Static variable in class de.themoep.minedown.adventure.MineDown
 
colorChar() - Method in class de.themoep.minedown.adventure.MineDownParser
Get The character to use as a special color code.
colorChar() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get the character to use as a special color code.
colorChar(char) - Method in class de.themoep.minedown.adventure.MineDown
Set a special character to replace color codes by if translating legacy colors is enabled.
colorChar(char) - Method in class de.themoep.minedown.adventure.MineDownParser
Set the character to use as a special color code.
colorChar(char) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set the character to use as a special color code.
colorInEventDefinition() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get whether or not to put colors in event definitions or use inline color definitions
colorInEventDefinition(boolean) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set whether or not to put colors in event definitions or use inline color definitions
colors() - Method in class de.themoep.minedown.adventure.MineDownParser
 
colors(Map<TextColor, Boolean>) - Method in class de.themoep.minedown.adventure.MineDownParser
 
componentReplacements() - Method in class de.themoep.minedown.adventure.Replacer
Get the map of placeholders with their component array replacements
components() - Method in class de.themoep.minedown.adventure.MineDown
 
copy() - Method in class de.themoep.minedown.adventure.MineDown
Copy all MineDown settings to a new instance
copy() - Method in class de.themoep.minedown.adventure.MineDownParser
Copy all the parser's setting to a new instance
copy() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Copy all the parser's setting to a new instance
copy() - Method in class de.themoep.minedown.adventure.Replacer
Create a copy of this Replacer
copy(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
Copy all the parser's setting to a new instance
copy(MineDown) - Method in class de.themoep.minedown.adventure.MineDown
Copy all MineDown settings from another one
copy(MineDownParser) - Method in class de.themoep.minedown.adventure.MineDownParser
Copy all the parser's settings from another parser.
copy(MineDownParser, boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
Copy all the parser's settings from another parser.
copy(MineDownStringifier) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Copy all the parser's settings from another parser
copy(Replacer) - Method in class de.themoep.minedown.adventure.Replacer
Copy all the values of another Replacer
createGradient(int, List<TextColor>) - Static method in class de.themoep.minedown.adventure.Util
createGradient(long, List<TextColor>) - Static method in class de.themoep.minedown.adventure.Util
Generate a gradient with certain colors
createRainbow(int, int) - Static method in class de.themoep.minedown.adventure.Util
createRainbow(long, int) - Static method in class de.themoep.minedown.adventure.Util
Generate a rainbow with a certain length and phase

D

de.themoep.minedown.adventure - package de.themoep.minedown.adventure
 
disable(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDown
Disable an option.
disable(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Disable an option.
distance(Color, Color) - Static method in class de.themoep.minedown.adventure.Util
Deprecated.
Doesn't use perceived brightness (HSV) but simply takes the distance between RGB. Do not rely on this, I twill look ugly!

E

enable(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDown
Enable an option.
enable(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Enable an option.
enabledOptions() - Method in class de.themoep.minedown.adventure.MineDownParser
Get all enabled options that will be used when parsing
enabledOptions(Set<MineDownParser.Option>) - Method in class de.themoep.minedown.adventure.MineDownParser
Set all enabled options that will be used when parsing at once, replaces any existing options
escape(String) - Static method in class de.themoep.minedown.adventure.MineDown
Escape all MineDown formatting in a string.
escape(String) - Method in class de.themoep.minedown.adventure.MineDownParser
Escape formatting in the string depending on this parser's options.

F

filter(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDown
Filter an option.
filter(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Filter an option.
filteredOptions() - Method in class de.themoep.minedown.adventure.MineDownParser
Get all filtered options that will be parsed and then removed from the string
filteredOptions(Set<MineDownParser.Option>) - Method in class de.themoep.minedown.adventure.MineDownParser
Set all filtered options that will be parsed and then removed from the string at once, replaces any existing options
font() - Method in class de.themoep.minedown.adventure.MineDownParser
 
FONT_PREFIX - Static variable in class de.themoep.minedown.adventure.MineDown
 
format() - Method in class de.themoep.minedown.adventure.MineDownParser
 
format(Map<TextDecoration, Boolean>) - Method in class de.themoep.minedown.adventure.MineDownParser
 
FORMAT_PREFIX - Static variable in class de.themoep.minedown.adventure.MineDown
 
formattingInEventDefinition() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get whether or not to put formatting in event definitions or use inline formatting definitions
formattingInEventDefinition(boolean) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set whether or not to put formatting in event definitions or use inline formatting definitions
formattingIsLegacy() - Method in class de.themoep.minedown.adventure.MineDownParser
 
formattingIsLegacy(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
 

G

getChar() - Method in enum de.themoep.minedown.adventure.Util.TextControl
 
getClosestLegacy(TextColor) - Static method in class de.themoep.minedown.adventure.Util
Deprecated.
Use NamedTextColor.nearestTo(TextColor)
getFormatFromChar(char) - Static method in class de.themoep.minedown.adventure.MineDown
Get the TextColor format from a MineDown string
getFormatFromLegacy(char) - Static method in class de.themoep.minedown.adventure.Util
Get a TextFormat from its legacy color code as kyori-text-api does not support that
getFormats(Component, boolean) - Static method in class de.themoep.minedown.adventure.Util
Get a set of TextColor formats all formats that a component includes
getFormatString(TextDecoration) - Static method in class de.themoep.minedown.adventure.MineDown
Get the string that represents the format in MineDown
getLegacyFormatChar(TextFormat) - Static method in class de.themoep.minedown.adventure.Util
Get the legacy color code from its format as kyori-text-api does not support that
getUnescapedEndIndex(String, char, char, int) - Static method in class de.themoep.minedown.adventure.Util
Gets the proper end index of a certain definition on the same depth while ignoring escaped chars.

H

HOVER_PREFIX - Static variable in class de.themoep.minedown.adventure.MineDown
 
hoverEvent() - Method in class de.themoep.minedown.adventure.MineDownParser
 
hoverEvent(HoverEvent) - Method in class de.themoep.minedown.adventure.MineDownParser
 
hoverTextWidth() - Method in class de.themoep.minedown.adventure.MineDownParser
Get the max width the hover text should have.
hoverTextWidth(int) - Method in class de.themoep.minedown.adventure.MineDown
Set the max width the hover text should have.
hoverTextWidth(int) - Method in class de.themoep.minedown.adventure.MineDownParser
Set the max width the hover text should have.

I

ignorePlaceholderCase() - Method in class de.themoep.minedown.adventure.MineDown
Get whether or not the case of the placeholder should be ignored when replacing
ignorePlaceholderCase() - Method in class de.themoep.minedown.adventure.Replacer
Replace the placeholder no matter what the case of it is
ignorePlaceholderCase(boolean) - Method in class de.themoep.minedown.adventure.MineDown
Set whether or not the case of the placeholder should be ignored when replacing
ignorePlaceholderCase(boolean) - Method in class de.themoep.minedown.adventure.Replacer
Set whether or not the placeholder should be replaced no matter what the case of it is
indexOfNotEscaped(String, String) - Static method in class de.themoep.minedown.adventure.Util
Get the index of the first occurrences of a not escaped character
indexOfNotEscaped(String, String, int) - Static method in class de.themoep.minedown.adventure.Util
Get the index of the first occurrences of a not escaped character
insertion() - Method in class de.themoep.minedown.adventure.MineDownParser
 
INSERTION_PREFIX - Static variable in class de.themoep.minedown.adventure.MineDown
 
isDouble(String, int) - Static method in class de.themoep.minedown.adventure.Util
Check whether or not a character at a certain index of a string repeats itself
isEnabled(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Check whether or not an option is enabled
isEscaped(String, int) - Static method in class de.themoep.minedown.adventure.Util
Check if a character at a certain index is escaped
isFiltered(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Check whether or not an option is filtered
isFormat(TextColor) - Static method in class de.themoep.minedown.adventure.Util
Check whether a certain TextColor is formatting or not

L

LEGACY_COLORS - Enum constant in enum de.themoep.minedown.adventure.MineDownParser.Option
Whether or not to translate legacy color codes (Default: true)
lenient() - Method in class de.themoep.minedown.adventure.MineDownParser
Get whether to accept malformed strings or not
lenient(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
Set whether to accept malformed strings or not

M

message() - Method in class de.themoep.minedown.adventure.MineDown
Get the set message that is to be parsed
message(String) - Method in class de.themoep.minedown.adventure.MineDown
Set the message that is to be parsed
MineDown - Class in de.themoep.minedown.adventure
MineDown-adventure
MineDown(String) - Constructor for class de.themoep.minedown.adventure.MineDown
Create a new MineDown builder with a certain message
MineDownParser - Class in de.themoep.minedown.adventure
 
MineDownParser() - Constructor for class de.themoep.minedown.adventure.MineDownParser
 
MineDownParser.Option - Enum in de.themoep.minedown.adventure
 
MineDownStringifier - Class in de.themoep.minedown.adventure
 
MineDownStringifier() - Constructor for class de.themoep.minedown.adventure.MineDownStringifier
 

P

parse(String) - Method in class de.themoep.minedown.adventure.MineDownParser
Create a ComponentBuilder by parsing a MineDown message
parse(String, String...) - Static method in class de.themoep.minedown.adventure.MineDown
Parse a MineDown string to components
parseEvent(String, String) - Method in class de.themoep.minedown.adventure.MineDownParser
Parse a MineDown event string
parseFormat(String, String, boolean) - Static method in class de.themoep.minedown.adventure.MineDownParser
Parse a color/format definition
parser() - Method in class de.themoep.minedown.adventure.MineDown
Get the parser instance that is currently used
placeholderIndicator(String) - Method in class de.themoep.minedown.adventure.MineDown
Set the placeholder indicator for both prefix and suffix
placeholderIndicator(String) - Method in class de.themoep.minedown.adventure.Replacer
Set the placeholder indicator for both prefix and suffix
placeholderPrefix() - Method in class de.themoep.minedown.adventure.MineDown
Get the placeholder indicator's prefix character
placeholderPrefix() - Method in class de.themoep.minedown.adventure.Replacer
Get the placeholder indicator's prefix string
placeholderPrefix(String) - Method in class de.themoep.minedown.adventure.MineDown
Set the placeholder indicator's prefix character
placeholderPrefix(String) - Method in class de.themoep.minedown.adventure.Replacer
Set the placeholder indicator's prefix string
placeholderSuffix() - Method in class de.themoep.minedown.adventure.MineDown
Get the placeholder indicator's suffix character
placeholderSuffix() - Method in class de.themoep.minedown.adventure.Replacer
Get the placeholder indicator's suffix string
placeholderSuffix(String) - Method in class de.themoep.minedown.adventure.MineDown
Set the placeholder indicator's suffix character
placeholderSuffix(String) - Method in class de.themoep.minedown.adventure.Replacer
Set the placeholder indicator's suffix string
preferSimpleEvents() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get whether or not to use simple event definitions or specific ones (Default: true)
preferSimpleEvents(boolean) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set whether or not to use simple event definitions or specific ones

R

rainbowPhase() - Method in class de.themoep.minedown.adventure.MineDownParser
 
rainbowPhase(Integer) - Method in class de.themoep.minedown.adventure.MineDownParser
 
replace(String...) - Method in class de.themoep.minedown.adventure.MineDown
Add an array with placeholders and values that should get replaced in the message
replace(String...) - Method in class de.themoep.minedown.adventure.Replacer
Add an array with placeholders and values that should get replaced in the message
replace(String, Component) - Method in class de.themoep.minedown.adventure.MineDown
Add a placeholder to component mapping that should get replaced in the message
replace(String, Component) - Method in class de.themoep.minedown.adventure.Replacer
Add a placeholder to component mapping that should get replaced in the message
replace(Map<String, ?>) - Method in class de.themoep.minedown.adventure.MineDown
Add a map with placeholders and values that should get replaced in the message
replace(Map<String, ?>) - Method in class de.themoep.minedown.adventure.Replacer
Add a map with placeholders and values that should get replaced in the message
replaceFirst() - Method in class de.themoep.minedown.adventure.MineDown
Get whether or not replacements should be replaced before or after the components are created.
replaceFirst(boolean) - Method in class de.themoep.minedown.adventure.MineDown
Set whether or not replacements should be replaced before or after the components are created.
replaceIn(String) - Method in class de.themoep.minedown.adventure.Replacer
Replace the placeholders in a string.
replaceIn(String, String...) - Static method in class de.themoep.minedown.adventure.Replacer
Replace certain placeholders with values in string.
replaceIn(List<Component>) - Method in class de.themoep.minedown.adventure.Replacer
Replace the placeholders in a component list
replaceIn(Component) - Method in class de.themoep.minedown.adventure.Replacer
Replace the placeholders in a component list
replaceIn(Component, String...) - Static method in class de.themoep.minedown.adventure.Replacer
Replace certain placeholders with values in a component array.
replaceIn(Component, String, Component) - Static method in class de.themoep.minedown.adventure.Replacer
Replace a certain placeholder with a component array in a component array.
replacements() - Method in class de.themoep.minedown.adventure.Replacer
Get the map of placeholders with their string replacements
replacer() - Method in class de.themoep.minedown.adventure.MineDown
Get the replacer instance that is currently used
Replacer - Class in de.themoep.minedown.adventure
This class offers the ability to replace placeholders with values in strings and components.
Replacer() - Constructor for class de.themoep.minedown.adventure.Replacer
 
reset() - Method in class de.themoep.minedown.adventure.MineDownParser
Reset the parser state to the start
RESET - Enum constant in enum de.themoep.minedown.adventure.Util.TextControl
 
rgbColorsToLegacy(Component) - Static method in class de.themoep.minedown.adventure.Util
Utility method to remove RGB colors from components.

S

SIMPLE_FORMATTING - Enum constant in enum de.themoep.minedown.adventure.MineDownParser.Option
Translate simple, in-line MineDown formatting in strings? (Default: true)
stringify(List<Component>) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Create a MineDown string from a component message
stringify(Component) - Static method in class de.themoep.minedown.adventure.MineDown
Convert components to a MineDown string
stringify(Component) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Create a MineDown string from a component message

T

toComponent() - Method in class de.themoep.minedown.adventure.MineDown
Parse and convert the message to the component
translateLegacyColors() - Method in class de.themoep.minedown.adventure.MineDownParser
Deprecated.
translateLegacyColors(boolean) - Method in class de.themoep.minedown.adventure.MineDown
translateLegacyColors(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser

U

unfilter(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDown
Unfilter an option.
unfilter(MineDownParser.Option) - Method in class de.themoep.minedown.adventure.MineDownParser
Unfilter an option.
URL_PATTERN - Static variable in class de.themoep.minedown.adventure.MineDownParser
 
urlDetection() - Method in class de.themoep.minedown.adventure.MineDownParser
Get whether or not urls in strings are detected and get events added to them?
urlDetection(boolean) - Method in class de.themoep.minedown.adventure.MineDown
Detect urls in strings and add events to them? (Default: true)
urlDetection(boolean) - Method in class de.themoep.minedown.adventure.MineDownParser
Set whether or not to detect urls in strings and add events to them?
urlHoverText() - Method in class de.themoep.minedown.adventure.MineDownParser
Get the text to display when hovering over an URL.
urlHoverText(String) - Method in class de.themoep.minedown.adventure.MineDown
The text to display when hovering over an URL
urlHoverText(String) - Method in class de.themoep.minedown.adventure.MineDownParser
Set the text to display when hovering over an URL.
useLegacyColors() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get whether or not to use legacy color codes
useLegacyColors(boolean) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set whether or not to use legacy color codes
useLegacyFormatting() - Method in class de.themoep.minedown.adventure.MineDownStringifier
Get whether or not to translate legacy formatting codes over MineDown ones
useLegacyFormatting(boolean) - Method in class de.themoep.minedown.adventure.MineDownStringifier
Set whether or not to translate legacy formatting codes over MineDown ones
Util - Class in de.themoep.minedown.adventure
 
Util() - Constructor for class de.themoep.minedown.adventure.Util
 
Util.TextControl - Enum in de.themoep.minedown.adventure
 

V

validate(boolean, String) - Static method in class de.themoep.minedown.adventure.Util
Utility method to throw an IllegalArgumentException if the value is false
value() - Method in class de.themoep.minedown.adventure.MineDownParser
 
value(StringBuilder) - Method in class de.themoep.minedown.adventure.MineDownParser
 
valueOf(String) - Static method in enum de.themoep.minedown.adventure.MineDownParser.Option
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.themoep.minedown.adventure.Util.TextControl
Returns the enum constant of this type with the specified name.
values() - Static method in enum de.themoep.minedown.adventure.MineDownParser.Option
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.themoep.minedown.adventure.Util.TextControl
Returns an array containing the constants of this enum type, in the order they are declared.

W

wrap(String, int) - Static method in class de.themoep.minedown.adventure.Util
Wrap a string if it is longer than the line length and contains no new line.
A B C D E F G H I L M P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values