Format TextXML

Sponge utilise une forme prédéfinie du XML appelée « TextXML » pour désigner la coloration et le style du texte. Une description des éléments et attributs sont les suivants :

Élément

Attribut

Description

a (ancre)

href

élément d’ancrage; Indique que ce texte va ouvrir le lien dans l’attribut href lorsqu’il sera cliqué.

b (gras)

Mets le texte en gras.

c (couleur)

n

Applique une couleur indiquée par l’attribut n (nom) au texte.

i (italique)

Mets le texte en italique.

o (offusqué)

Offusque le texte (remplace les caractères par des caractères aléatoires qui changent en permanence).

s (barré)

Barre le texte.

span

onClick, onHover

Élément de support générique qui peut avoir des actions de clic et/ou de survol indiquées par les attributs onClick et onHover, respectivement

tr (traduction)

key

Indique une traduction du texte

u (souligné)

Souligne le texte.

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

<c n="red">
    <u>Hello World!</u>
</c>

Cette sortie peut être produite à l’aide du code suivant :

import org.spongepowered.api.text.Text;
import org.spongepowered.api.text.format.TextColors;
import org.spongepowered.api.text.format.TextStyles;
import org.spongepowered.api.text.serializer.TextSerializers;

Text text = Text.of(TextColors.RED, TextStyles.UNDERLINE, "Hello World!");
String xmlText = TextSerializers.TEXT_XML.serialize(text);