Text Nodes and Node Parsers¶
What are TextNodes?¶
It is extensible representation of parsed text, allowing for simpler and more compatible parsing without losing vanilla compatibility. It can be used for templating, which can minimize time required for parsing static text multiple times for placeholder insertion. There are 2 main types of TextNodes.
Value Text Nodes¶
This type of TextNode contains any text or defining information that isn't dependent on formatting. It is the lowest level on which parsers generally operate.
You can create your own custom one by implementing
The context is used mostly to allow for dynamic templating/values (for example placeholder context). The
removeBackslash option defines whatever LiteralNode should remove
\ symbol while it's used for escaping formatting.
- LiteralNode - Used for direct text, requires special parsing by parsers,
- TranslationNode - Used for translated text, also requires special parsing,
- DirectTextNode - Allows you to insert non-transformable text, can be used for static placeholders,
- PlaceholderNode (Internal) - Used for representing parsed placeholder without fetching it's final value.
Parent Text Nodes¶
This type is used for joining multiple Value/Parent Text Nodes into single object. Additionally, they are used to add any type of formatting like colors, hovers or fonts. Most of builtin ParentNodes do single type of formatting.
You can create your own by extending
ParentNode class or implementing
- ParentNode - Most basic parent node, used purely for grouping elements,
- HoverNode - Adds HoverEvent to text,
- GradientNode - Allows inputting gradients for final text, without breaking parsing before.
Simply put, Node Parsers are parsers operating on Text Nodes. They use them both as input and output, allowing them to easily stack with other Node Parsers. They need to implement a
To use Node Parsers, you first need to get instance of it and then invoke one of provided method.
Text Placeholder API comes with multiple builtin parsers:
- TextParserV1 (See more here!) - Tag based parser for user input,
- MarkdownLiteParserV1 - Minimalistic Markdown parser with only vanilla compatible formatting,
- LegacyFormattingParser - Simple parser adding support for legacy (&) formatting,
- PatternPlaceholderParser - Backend parser used by placeholder implementation. Added as NodeParser with 2.0.0-pre.4.
Custom Node Parsers¶
Implementing custom Node Parsers might be tricky. But the simplest one boils down to implementing NodeParser.
Default implementation should support parsing
ParentNode to be considered functional.
Then it can be used directly just like any other builtin NodeParser.