Interface ConfigurateComponentSerializer
- All Superinterfaces:
net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.Component,org.spongepowered.configurate.ConfigurationNode>
public interface ConfigurateComponentSerializer
extends net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.Component,org.spongepowered.configurate.ConfigurationNode>
A serializer that will output to Configurate
ConfigurationNode
s.
This serializer only modifies its own serializer collection. To add to another collection, get that collection. Serializers are added for every Adventure data type.
The preferred way to use Configurate integration is by registering this serializer's type serializers with a separate
- Since:
- 4.2.0
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ConfigurateComponentSerializer.Builder
A builder for a configurate serializer instance. -
Method Summary
Modifier and Type Method Description static @NonNull ConfigurateComponentSerializer.Builder
builder()
Create a new builder for a customized Configurate serializer.static @NonNull ConfigurateComponentSerializer
configurate()
Get an instance with default settings.@NonNull org.spongepowered.configurate.serialize.TypeSerializerCollection
serializers()
Get the serializers provided for Adventure.
-
Method Details
-
configurate
Get an instance with default settings.- Returns:
- the shared default instance
- Since:
- 4.2.0
-
builder
Create a new builder for a customized Configurate serializer.- Returns:
- a new builder
- Since:
- 4.2.0
-
serializers
@NonNull org.spongepowered.configurate.serialize.TypeSerializerCollection serializers()Get the serializers provided for Adventure.- Returns:
- a collection containing Adventure serializers
- Since:
- 4.2.0
-