Package dev.majek.hexnicks.message
Interface MiniMessageWrapper.Builder
- Enclosing interface:
- MiniMessageWrapper
public static interface MiniMessageWrapper.Builder
A builder for
MiniMessageWrapper
.- Since:
- 2.1.2
-
Method Summary
Modifier and TypeMethodDescription@NotNull MiniMessageWrapper.Builder
advancedTransformations
(boolean parse) Whether to parse advancedTag
s on the final string to be parsed.@NotNull MiniMessageWrapper
build()
Build theMiniMessageWrapper
ready to parse.@NotNull MiniMessageWrapper.Builder
gradients
(boolean parse) Whether gradients on the final string should be parsed.@NotNull MiniMessageWrapper.Builder
hexColors
(boolean parse) Whether hex colors on the final string should be parsed.@NotNull MiniMessageWrapper.Builder
legacyColors
(boolean parse) Whether legacy color codes on the final string should be parsed.@NotNull MiniMessageWrapper.Builder
placeholderResolver
(@NotNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver placeholderResolver) Set theTagResolver
for theMiniMessage
instance.@NotNull MiniMessageWrapper.Builder
removeColors
(@NotNull Collection<@NotNull net.kyori.adventure.text.format.NamedTextColor> colors) TheNamedTextColor
s that should not be parsed.@NotNull MiniMessageWrapper.Builder
removeColors
(@NotNull net.kyori.adventure.text.format.NamedTextColor... colors) TheNamedTextColor
s that should not be parsed.@NotNull MiniMessageWrapper.Builder
removeTextDecorations
(@NotNull Collection<@NotNull net.kyori.adventure.text.format.TextDecoration> decorations) TheTextDecoration
s that should not be parsed.@NotNull MiniMessageWrapper.Builder
removeTextDecorations
(@NotNull net.kyori.adventure.text.format.TextDecoration... decorations) TheTextDecoration
s that should not be parsed.@NotNull MiniMessageWrapper.Builder
standardColors
(boolean parse) Whether all standard color codes on the final string should be parsed.
-
Method Details
-
gradients
Whether gradients on the final string should be parsed.- Parameters:
parse
- whether to parse- Returns:
- this builder
- Since:
- 2.1.2
-
hexColors
Whether hex colors on the final string should be parsed.- Parameters:
parse
- whether to parse- Returns:
- this builder
- Since:
- 2.1.2
-
standardColors
Whether all standard color codes on the final string should be parsed.- Parameters:
parse
- whether to parse- Returns:
- this builder
- Since:
- 2.1.2
-
legacyColors
Whether legacy color codes on the final string should be parsed.- Parameters:
parse
- whether to parse- Returns:
- this builder
- Since:
- 2.1.2
-
advancedTransformations
Whether to parse advancedTag
s on the final string to be parsed. This includes click events, hover events, fonts, etc.- Parameters:
parse
- whether to parse- Returns:
- this builder
- Since:
- 2.1.2
-
removeTextDecorations
@NotNull @NotNull MiniMessageWrapper.Builder removeTextDecorations(@NotNull @NotNull net.kyori.adventure.text.format.TextDecoration... decorations) TheTextDecoration
s that should not be parsed.- Parameters:
decorations
- the decorations- Returns:
- this builder
- Since:
- 2.2.0
-
removeTextDecorations
@NotNull @NotNull MiniMessageWrapper.Builder removeTextDecorations(@NotNull @NotNull Collection<@NotNull net.kyori.adventure.text.format.TextDecoration> decorations) TheTextDecoration
s that should not be parsed.- Parameters:
decorations
- the decorations- Returns:
- this builder
- Since:
- 3.0.0
-
placeholderResolver
@NotNull @NotNull MiniMessageWrapper.Builder placeholderResolver(@NotNull @NotNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver placeholderResolver) Set theTagResolver
for theMiniMessage
instance.- Parameters:
placeholderResolver
- the placeholder resolver- Returns:
- this builder
- Since:
- 2.2.1
-
removeColors
@NotNull @NotNull MiniMessageWrapper.Builder removeColors(@NotNull @NotNull net.kyori.adventure.text.format.NamedTextColor... colors) TheNamedTextColor
s that should not be parsed.- Parameters:
colors
- the colors- Returns:
- this builder
- Since:
- 2.2.1
-
removeColors
@NotNull @NotNull MiniMessageWrapper.Builder removeColors(@NotNull @NotNull Collection<@NotNull net.kyori.adventure.text.format.NamedTextColor> colors) TheNamedTextColor
s that should not be parsed.- Parameters:
colors
- the colors- Returns:
- this builder
- Since:
- 3.0.0
-
build
Build theMiniMessageWrapper
ready to parse.- Returns:
- the wrapper
- Since:
- 2.1.2
-