Index (PrismaticAPI 1.5.0 API)

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

A

accept(String) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Parses a raw string into a typed result without player context.
accept(Player, String) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Parses a raw string into a typed result using the given player as context for version-aware color resolution.
adventure() - Static method in class me.croabeast.prismatic.PrismaticAPI: Returns the Adventure formatter facade when the required Adventure classes are present at runtime.
append(Object) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Appends the string representation of an object as a new raw-text segment.
append(String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Parses the given raw text and appends the resulting segments to this component.
append(ChatComponent<?>) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Appends an existing ChatComponent as a new segment at the end of this component.
apply(String, boolean) - Method in interface me.croabeast.prismatic.color.ColorPattern: Applies this pattern to a string.
applyColor(Color, String, boolean) - Method in interface me.croabeast.prismatic.Formatter: Applies a single color to the beginning of a string.
applyColor(Color, String, boolean) - Static method in class me.croabeast.prismatic.PrismaticAPI: Applies a single color to the beginning of a string.
applyGradient(String, Color, Color, boolean) - Method in interface me.croabeast.prismatic.Formatter: Applies a per-character gradient between two colors.
applyGradient(String, Color, Color, boolean) - Static method in class me.croabeast.prismatic.PrismaticAPI: Applies a per-character gradient between two colors.
applyRainbow(String, float, boolean) - Method in interface me.croabeast.prismatic.Formatter: Applies a per-character rainbow effect.
applyRainbow(String, float, boolean) - Static method in class me.croabeast.prismatic.PrismaticAPI: Applies a per-character rainbow effect.
asBukkit() - Method in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Returns the underlying Bungee ClickEvent.Action for this click type.

C

CHANGE_PAGE - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Changes the current page in a written book.
chatComponent(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Creates a mutable interactive chat component.
ChatComponent<C> - Interface in me.croabeast.prismatic.chat: A mutable, fluent Bungee/Spigot chat component that supports optional click and hover events.
ChatComponent.Click - Enum Class in me.croabeast.prismatic.chat: Enumeration of the click actions that a ChatComponent can carry.
ChatFormat<T> - Interface in me.croabeast.prismatic.chat: A typed text-format contract used by MultiComponent to parse and serialize interactive component markup.
ChatFormat.Holder - Class in me.croabeast.prismatic.chat: Internal cache that stores compiled Pattern instances keyed by their source regex string.
ChatProcessor - Interface in me.croabeast.prismatic.chat: Small formatting bridge used by Prismatic chat components.
CLICK_REGEX - Static variable in interface me.croabeast.prismatic.chat.MultiComponent: Regex fragment that matches all recognized click-action aliases accepted in markup.
CLIPBOARD - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Copies text to the player's clipboard.
COLOR_PATTERNS - Static variable in interface me.croabeast.prismatic.color.ColorPattern: Immutable ordered list of the built-in processors used by the default Prismatic pipeline.
colorize(String) - Method in interface me.croabeast.prismatic.Formatter: Parses and colorizes a string without player context.
colorize(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Parses and colorizes a string using the conservative no-player fallback.
colorize(Player, String) - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Applies colors to the given text.
colorize(Player, String) - Method in interface me.croabeast.prismatic.Formatter: Parses and colorizes a string using the full Prismatic pipeline for a specific player context.
colorize(Player, String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Parses and colorizes a string using the full Prismatic pipeline for a specific player context.
ColorPattern - Interface in me.croabeast.prismatic.color: Low-level contract for Prismatic color-pattern processors.
compile(Player) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Compiles this component into a BaseComponent array ready for Spigot/Bungee chat APIs.
copy() - Method in interface me.croabeast.prismatic.chat.MultiComponent: Returns a deep copy of this multi-component, including all current segments and the current format.

D

DEFAULT_FORMAT - Static variable in interface me.croabeast.prismatic.chat.MultiComponent: The default ChatFormat instance used when a MultiComponent is created without an explicit format.
DEFAULT_REGEX - Static variable in interface me.croabeast.prismatic.chat.MultiComponent: The default markup regex used by MultiComponent.DEFAULT_FORMAT to identify interactive segments.

E

EXECUTE - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Runs a command as the player who clicks the text.

F

Formatter<T> - Interface in me.croabeast.prismatic: Shared contract implemented by the legacy() and adventure() facades.
fromName(String) - Static method in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Resolves a Click constant from a string alias.
fromString(String) - Static method in interface me.croabeast.prismatic.chat.ChatComponent: Creates a new ChatComponent backed by the default Prismatic processor.
fromString(String) - Static method in interface me.croabeast.prismatic.chat.MultiComponent: Creates a new MultiComponent backed by the default Prismatic processor.
fromString(String) - Method in interface me.croabeast.prismatic.Formatter: Parses a color token into a chat color.
fromString(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Parses a color token into a ChatColor.
fromString(String, boolean) - Method in interface me.croabeast.prismatic.Formatter: Converts a bare six-digit hexadecimal RGB value into a chat color.
fromString(String, boolean) - Static method in class me.croabeast.prismatic.PrismaticAPI: Converts a bare six-digit hexadecimal RGB value into a ChatColor.
fromString(ChatProcessor, String) - Static method in interface me.croabeast.prismatic.chat.ChatComponent: Creates a new ChatComponent backed by the given ChatProcessor.
fromString(ChatProcessor, String) - Static method in interface me.croabeast.prismatic.chat.MultiComponent: Creates a new MultiComponent backed by a custom ChatProcessor.

G

getEndColor(String) - Method in interface me.croabeast.prismatic.Formatter: Returns the last color code found in the formatted representation of a string.
getEndColor(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Returns the last color code found in the formatted representation of a string.
getFormat() - Method in interface me.croabeast.prismatic.chat.MultiComponent: Returns the ChatFormat used by this component to parse markup and serialize segments back to their string representation.
getLineSeparator() - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Literal separator used when a hover text is serialized back to component markup.
getLineSeparatorRegex() - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Regex used to split hover text into lines.
getMessage() - Method in interface me.croabeast.prismatic.chat.ChatComponent: Returns the raw, un-colorized message text stored in this component.
getRegex() - Method in interface me.croabeast.prismatic.chat.ChatFormat: Returns the regular expression used to detect and extract segments handled by this format.
getStartColor(String) - Method in interface me.croabeast.prismatic.Formatter: Returns the first color code found in the formatted representation of a string.
getStartColor(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Returns the first color code found in the formatted representation of a string.

H

hasEvents() - Method in interface me.croabeast.prismatic.chat.ChatComponent: Returns true when this component has at least one click or hover event attached.

I

instance() - Method in interface me.croabeast.prismatic.chat.ChatComponent: Returns the concrete implementation instance of this component.
isAdventureAvailable() - Static method in class me.croabeast.prismatic.PrismaticAPI: Checks whether the Adventure facade can be used safely at runtime.
isFormatted(String) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Returns true when this format's regex finds at least one match inside the given string.

L

legacy() - Static method in class me.croabeast.prismatic.PrismaticAPI: Returns the always-safe legacy formatter facade.

M

matcher(String) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Creates a Matcher for the given text using the pattern derived from ChatFormat.getRegex().
me.croabeast.prismatic - package me.croabeast.prismatic
me.croabeast.prismatic.chat - package me.croabeast.prismatic.chat
me.croabeast.prismatic.color - package me.croabeast.prismatic.color
MULTI - Static variable in interface me.croabeast.prismatic.color.ColorPattern: Built-in processor for gradients, rainbows and other multi-color Prismatic tags.
multiComponent(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Creates a mutable multi-component that can parse click and hover markup.
MultiComponent - Interface in me.croabeast.prismatic.chat: A composite ChatComponent that splits a raw message into interactive segments and manages them as a unified, fluent unit.

O

OPEN_FILE - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Opens a file on the player's local filesystem (rarely used in practice).
OPEN_URL - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Opens a URL in the player's default browser.

P

prepare(String) - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Applies optional pre-processing before a multi-component is split into segments.
prismatic() - Static method in interface me.croabeast.prismatic.chat.ChatProcessor: Returns the default processor backed by PrismaticAPI.
PrismaticAPI - Class in me.croabeast.prismatic: Main entry point for the PrismaticAPI formatting pipeline.

R

removeFormat(String) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Removes every occurrence of this format from the given string, leaving only the surrounding plain text.

S

setClick(String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Attaches a click event from a compact "action:payload" string.
setClick(String, String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Attaches a click event to this component using a string alias for the action.
setClick(ChatComponent.Click, String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Attaches a click event to this component.
setClickToAll(String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a click event to every segment from a compact "action:payload" string.
setClickToAll(String, String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a click event to every segment in this component using a string alias.
setClickToAll(ChatComponent.Click, String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a click event to every segment in this component.
setFormat(ChatFormat<ChatComponent<?>>) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Replaces the ChatFormat used by this component.
setHover(String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Sets a text hover event from a single, optionally multi-line string.
setHover(String...) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Sets a text hover event whose content is drawn from the provided lines.
setHover(List<String>) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Sets a text hover event whose content is drawn from the provided lines.
setHoverItem(String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Sets an item hover event whose content is described by an NBT/SNBT JSON string.
setHoverItemToAll(String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies an item hover event to every segment in this component.
setHoverToAll(String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a text hover event to every segment from a single, optionally multi-line string.
setHoverToAll(String...) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a text hover event to every segment in this component.
setHoverToAll(List<String>) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Applies a text hover event to every segment in this component.
setMessage(String) - Method in interface me.croabeast.prismatic.chat.ChatComponent: Replaces the raw message text of this component.
setMessage(String) - Method in interface me.croabeast.prismatic.chat.MultiComponent: Unsupported — the message of a MultiComponent is derived from its individual segments and cannot be replaced as a single string.
SINGLE - Static variable in interface me.croabeast.prismatic.color.ColorPattern: Built-in processor for single RGB tokens such as {#ff8800} or &#ff8800.
splitLines(String) - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Splits text into lines without a limit.
splitLines(String, int) - Method in interface me.croabeast.prismatic.chat.ChatProcessor: Splits text into lines using ChatProcessor.getLineSeparatorRegex().
startsWithColor(String) - Method in interface me.croabeast.prismatic.Formatter: Determines whether the formatted representation of a string starts with a color code.
startsWithColor(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Determines whether the formatted representation of a string starts with a color code.
strip(String) - Method in interface me.croabeast.prismatic.color.ColorPattern: Removes the syntax handled by this pattern from a string.
stripAll(String) - Method in interface me.croabeast.prismatic.Formatter: Removes Bukkit colors, Bukkit special formatting, MiniMessage tags and Prismatic RGB syntax from a string.
stripAll(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Removes Bukkit colors, Bukkit special formatting, MiniMessage tags and Prismatic RGB syntax from a string.
stripBukkit(String) - Method in interface me.croabeast.prismatic.Formatter: Removes standard Bukkit color codes from a string.
stripBukkit(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Removes standard Bukkit color codes from a string.
stripMiniMessage(String) - Method in interface me.croabeast.prismatic.Formatter: Removes MiniMessage formatting tags from a string.
stripMiniMessage(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Removes MiniMessage formatting tags from a string.
stripRGB(String) - Method in interface me.croabeast.prismatic.Formatter: Removes Prismatic RGB, gradient and rainbow syntax from a string while leaving legacy Bukkit codes untouched.
stripRGB(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Removes Prismatic RGB, gradient and rainbow syntax from a string while leaving legacy Bukkit codes untouched.
stripSpecial(String) - Method in interface me.croabeast.prismatic.Formatter: Removes Bukkit special formatting codes from a string.
stripSpecial(String) - Static method in class me.croabeast.prismatic.PrismaticAPI: Removes Bukkit special formatting codes from a string.
SUGGEST - Enum constant in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Inserts text into the player's chat input without sending it.

T

toFormattedString() - Method in interface me.croabeast.prismatic.chat.MultiComponent: Serializes this component back to its formatted markup string using the current ChatFormat.
toFormattedString(T) - Method in interface me.croabeast.prismatic.chat.ChatFormat: Serializes a previously parsed result back to its formatted markup representation.
toString() - Method in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Returns the primary lowercase alias for this click type (e.g.

U

URL_PATTERN - Static variable in interface me.croabeast.prismatic.chat.ChatComponent: URL detector used to automatically attach ChatComponent.Click.OPEN_URL click events to any URL-only segment found inside the raw message during ChatComponent.compile(Player).

V

valueOf(String) - Static method in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.croabeast.prismatic.chat.ChatComponent.Click: Returns an array containing the constants of this enum class, in the order they are declared.

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