Konfigurations-Format

SpongeAPI offers support to serialize text directly to a Configurate configuration file through the use of the TypeToken class. Text objects are saved using the same node structure as the Text's JSON Format, but in a more flexible format called Human-Optimized Config Object Notation (HOCON).

Tipp

Für mehr Informationen wie du Configurate für Konfigurationsdateien für dein Plugin verwendest, halte dich bitte an die Plugins konfigurieren Dokumentation.

For example, the text "Hello World!", formatted with the color red and an underline, would have the following HOCON representation:

{
    underlined=true
    color=red
    text="Hello World!"
}

Um ein Text Objekt zu speichern, reicht es den Wert entsprechend des Beispiels in den gewünschten Knoten zu setzen:

import com.google.common.reflect.TypeToken;
import ninja.leaping.configurate.ConfigurationNode;
import org.spongepowered.api.text.Text;
import org.spongepowered.api.text.format.TextColors;
import org.spongepowered.api.text.format.TextStyles;

ConfigurationNode node = loader.load();
Text text = Text.of(TextColors.RED, TextStyles.UNDERLINE, "Hello World!");
node.getNode("mytext").setValue(TypeToken.of(Text.class), text);
loader.save(node);

Man kann dann ein Text Objekt mithilfe des folgenden Codes laden:

Text text = node.getNode("mytext").getValue(TypeToken.of(Text.class));

Bemerkung

Diese Strategie ist nicht begrenzt auf den HoconConfigurationLoader, sondern funktioniert mit allen ConfigurationLoadern.