Format de Configuration

SpongeAPI offre un support pour sérialiser du texte directement en un fichier de configuration Configurate via l’utilisation de la clase TypeToken. Les objets Text sont sauvegardés en utilisant la même structure de nodes que le Format JSON du Text, mais dans un format plus flexible appelé Human-Optimized Config Object Notation (HOCON).

Astuce

Pour des informations sur comment utiliser Configurate pour créer des fichiers de configuration pour vos plugins, veuillez vous reporter à Configuration des plugins.

Par exemple, le texte "Hello World!", formaté avec la couleur rouge et en souligné, aurait la représentation HOCON suivante :

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

Pour sauvegarder un objet Text définissez simplement la valeur du node désiré en utilisant le code suivant :

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);

Vous pouvez ensuite charger un objet Text en utilisant le code suivant :

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

Note

Cette stratégie n’est pas limitée à HoconConfigurationLoader; n’importe quel ConfigurationLoader suffira.