Interface Tag
-
- All Known Subinterfaces:
Inserting
,Modifying
,ParserDirective
,PreProcess
- All Known Implementing Classes:
TransitionTag
public interface Tag
A tag definition for the MiniMessage language.All implementations of
Tag
must implement one ofInserting
,Modifying
,ParserDirective
orPreProcess
.- Since:
- 4.10.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Tag.Argument
An argument that can be passed to a tag, after the first:
.
-
Method Summary
Static Methods Modifier and Type Method Description static @NotNull Tag
inserting(@NotNull Component content)
Create a tag that will insert a certain component into the output.static @NotNull Tag
inserting(@NotNull ComponentLike value)
Create a tag that will insert a certain component into the output.static @NotNull PreProcess
preProcessParsed(@NotNull String content)
Create a tag that inserts the content literally into the parse string.static @NotNull Tag
selfClosingInserting(@NotNull Component content)
Create a tag that will insert a certain component into the output.static @NotNull Tag
selfClosingInserting(@NotNull ComponentLike value)
Create a tag that will insert a certain component into the output.static @NotNull Tag
styling(@NotNull StyleBuilderApplicable @NotNull ... actions)
Create a tag that will apply certain styles to components.static @NotNull Tag
styling(Consumer<Style.Builder> styles)
Create a tag that will apply a certain style to components.
-
-
-
Method Detail
-
preProcessParsed
@NotNull static @NotNull PreProcess preProcessParsed(@NotNull @NotNull String content)
Create a tag that inserts the content literally into the parse string.- Parameters:
content
- content to insert- Returns:
- a new tag
- Since:
- 4.10.0
-
inserting
@NotNull static @NotNull Tag inserting(@NotNull @NotNull Component content)
Create a tag that will insert a certain component into the output.Any content between this tag and an explicit closing tag will become a child of
content
.- Parameters:
content
- the content to insert.- Returns:
- a tag that will insert this component
- Since:
- 4.10.0
-
inserting
@NotNull static @NotNull Tag inserting(@NotNull @NotNull ComponentLike value)
Create a tag that will insert a certain component into the output.Any content between this tag and an explicit closing tag will become a child of
content
.- Parameters:
value
- the content to insert, eagerly converted to a component- Returns:
- a tag that will insert this component
- Since:
- 4.10.0
-
selfClosingInserting
@NotNull static @NotNull Tag selfClosingInserting(@NotNull @NotNull Component content)
Create a tag that will insert a certain component into the output.This tag is self-closing, so its contents will not influence the style of following content.
- Parameters:
content
- the content to insert.- Returns:
- a tag that will insert this component
- Since:
- 4.10.0
-
selfClosingInserting
@NotNull static @NotNull Tag selfClosingInserting(@NotNull @NotNull ComponentLike value)
Create a tag that will insert a certain component into the output.This tag is self-closing, so its contents will not influence the style of following content.
- Parameters:
value
- the content to insert, eagerly converted to a component- Returns:
- a tag that will insert this component
- Since:
- 4.10.0
-
styling
@NotNull static @NotNull Tag styling(Consumer<Style.Builder> styles)
Create a tag that will apply a certain style to components.- Parameters:
styles
- the action applied to the component style- Returns:
- a tag for this action
- Since:
- 4.10.0
-
styling
@NotNull static @NotNull Tag styling(@NotNull @NotNull StyleBuilderApplicable @NotNull ... actions)
Create a tag that will apply certain styles to components.- Parameters:
actions
- the style builder actions- Returns:
- a tag for these actions
- Since:
- 4.10.0
-
-