Package dev.majek.chattools

Interface MiniMessageWrapper

All Superinterfaces:

net.kyori.adventure.util.Buildable<MiniMessageWrapper,MiniMessageWrapper.Builder>

public interface MiniMessageWrapper
extends net.kyori.adventure.util.Buildable<MiniMessageWrapper,MiniMessageWrapper.Builder>

A wrapper for MiniMessage to add a few more methods for more customization.

Author:

Majekdor

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MiniMessageWrapper.Builder	A builder for MiniMessageWrapper.

Method Summary

Modifier and Type	Method	Description
static @NotNull MiniMessageWrapper.Builder	builder()	Creates a new MiniMessageWrapper.Builder.
static @NotNull MiniMessageWrapper	legacy()	Gets a simple instance with legacy code support.
@NotNull net.kyori.adventure.text.Component	mmParse(@NotNull String mmString)	Parse a string into a Component using MiniMessage.
@NotNull String	mmString(@NotNull String mmString)	Get the modified string.
static @NotNull MiniMessageWrapper	standard()	Gets a simple instance.
@NotNull MiniMessageWrapper.Builder	toBuilder()	Create a MiniMessageWrapper.Builder to modify options.

Method Detail

standard

@NotNull
static @NotNull MiniMessageWrapper standard()

Gets a simple instance.

This will parse everything like MiniMessage will except for advanced transformations.

Builder options with this instance:

• Gradients: True
• Hex Colors: True
• Standard Colors: True
• Legacy Colors: False
• Advanced Transformations: False
• Placeholder Resolver: Empty
• Block Text Decorations: None
• Blocked Colors: None
• Luminance Threshold: 0

Returns:

a simple instance

legacy

@NotNull
static @NotNull MiniMessageWrapper legacy()

Gets a simple instance with legacy code support.

This will parse everything like MiniMessage will with the addition of legacy code support and the subtraction of advanced transformation support.

Builder options with this instance:

• Gradients: True
• Hex Colors: True
• Standard Colors: True
• Legacy Colors: True
• Advanced Transformations: False
• Placeholder Resolver: Empty
• Block Text Decorations: None
• Blocked Colors: None
• Luminance Threshold: 0

Returns:

a simple instance

mmParse

@NotNull
@NotNull net.kyori.adventure.text.Component mmParse(@NotNull
                                                    @NotNull String mmString)

Parse a string into a Component using MiniMessage.

Parameters:

mmString - the string to parse

Returns:

component

mmString

@NotNull
@NotNull String mmString(@NotNull
                         @NotNull String mmString)

Get the modified string.

Parameters:

mmString - string to modify

Returns:

modified string

builder

@NotNull
static @NotNull MiniMessageWrapper.Builder builder()

Creates a new MiniMessageWrapper.Builder.

Default builder options:

• Gradients: True
• Hex Colors: True
• Standard Colors: True
• Legacy Colors: False
• Advanced Transformations: False

Returns:

a builder

toBuilder

@NotNull
@NotNull MiniMessageWrapper.Builder toBuilder()

Create a MiniMessageWrapper.Builder to modify options.

Specified by:

toBuilder in interface net.kyori.adventure.util.Buildable<MiniMessageWrapper,MiniMessageWrapper.Builder>

Returns:

a builder