Interface GsonComponentSerializer
-
- All Superinterfaces:
net.kyori.adventure.util.Buildable<GsonComponentSerializer,GsonComponentSerializer.Builder>
,net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.Component,String>
public interface GsonComponentSerializer extends net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.Component,String>, net.kyori.adventure.util.Buildable<GsonComponentSerializer,GsonComponentSerializer.Builder>
A gson component serializer.Use
GsonComponentSerializer.Builder.downsampleColors()
to support platforms that do not understand hex colors that were introduced in Minecraft 1.16.- Since:
- 4.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
GsonComponentSerializer.Builder
A builder forGsonComponentSerializer
.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static GsonComponentSerializer.Builder
builder()
Creates a newGsonComponentSerializer.Builder
.static @NonNull GsonComponentSerializer
colorDownsamplingGson()
Gets a component serializer for gson serialization and deserialization.static @NonNull GsonComponentSerializer
gson()
Gets a component serializer for gson serialization and deserialization.@NonNull UnaryOperator<com.google.gson.GsonBuilder>
populator()
Gets the underlying gson populator.@NonNull com.google.gson.Gson
serializer()
Gets the underlying gson serializer.
-
-
-
Method Detail
-
gson
static @NonNull GsonComponentSerializer gson()
Gets a component serializer for gson serialization and deserialization.- Returns:
- a gson component serializer
- Since:
- 4.0.0
-
colorDownsamplingGson
static @NonNull GsonComponentSerializer colorDownsamplingGson()
Gets a component serializer for gson serialization and deserialization.Hex colors are coerced to the nearest named color, and legacy hover events are emitted for action
HoverEvent.Action.SHOW_TEXT
.- Returns:
- a gson component serializer
- Since:
- 4.0.0
-
builder
static GsonComponentSerializer.Builder builder()
Creates a newGsonComponentSerializer.Builder
.- Returns:
- a builder
- Since:
- 4.0.0
-
serializer
@NonNull com.google.gson.Gson serializer()
Gets the underlying gson serializer.- Returns:
- a gson serializer
- Since:
- 4.0.0
-
populator
@NonNull UnaryOperator<com.google.gson.GsonBuilder> populator()
Gets the underlying gson populator.- Returns:
- a gson populator
- Since:
- 4.0.0
-
-