Création de Text

Formatted text can be created using Component factories as described in this section. The robust text API can be used in a variety of ways to combine styling, coloring, and actions.

Text non formaté

Oftentimes, all you need is unformatted text. Unformatted text is the simplest form of text to create.

Exemple:

import net.kyori.adventure.text.Component;

Component unformattedText = Component.text("Hey! This is unformatted text!");

L’extrait de code illustré ci-dessous retourne du texte non formaté, sans couleur, avec aucune action de texte configurée.

Formatted Text

The Component interface allows for the creation of formatted text in a « building-block » style. Components in Adventure act like builders where any Component can be amended with colors, decorations, etc. Components are immutable, so using these builder-like methods will create a copy each time. There is no need to call .build() at the end, unlike with Sponge’s previous Text API from API 7 and below.

Astuce

Consultez cet article Wikipedia afin de vous aider à comprendre le but du monteur (builder pattern) dans l’ingénierie logicielle.

Couleurs

One usage of the text API is the addition of colors to text, as illustrated below.

Exemple: Texte en couleur

import net.kyori.adventure.text.format.NamedTextColor;

Component coloredText = Component.text("Woot! Golden text is golden.", NamedTextColor.GOLD);

Any Minecraft color specified within the NamedTextColor class can be used when coloring text, as well as full-RGB colors using TextColor. Multiple colors can be used in text by appending additional texts with different colors:

Exemple: Texte Multicolor

import net.kyori.adventure.text.format.TextColor;

Component multiColoredText = Component.text("Sponges are ", NamedTextColor.YELLOW).append(
        Component.text("invincible!", TextColor.color(0x5fb0ff)));

Stylisation

The API can also be used to style text, including underlining, italicizing, etc. This is called « decorating » in the Adventure library.

Exemple: Texte Stylisé

import net.kyori.adventure.text.format.TextDecoration;

Component styledText = Component.text("Yay! Styled text!").decorate(TextDecoration.ITALIC);
Component shortcutText = Component.text("Shortcut for both!", NamedTextColor.GRAY, TextDecoration.UNDERLINE);

Tout comme les couleurs, plusieurs styles peuvent être utilisés en enchaînant plusieurs textes séparément stylisés.

Exemple: Texte à styles multiples

Component multiStyledText = Component.text("I'm italicized! ").decorate(TextDecoration.ITALIC)
        .append(Component.text("I'm bold!").decorate(TextDecoration.BOLD));

Text Events

Components also offer the ability to create actions for text. Any action within the HoverEvent or ClickEvent classes can be used when creating text actions for text. Sponge provides additional actions in SpongeComponents. The method below is a small example of what text actions can do.

Example: Text with an Event

import net.kyori.adventure.text.event.ClickEvent;

Component clickableText = Component.text("Click here!")
    .clickEvent(ClickEvent.runCommand("tell Spongesquad I'm ready!"));

Component callbackText = Component.text("Click here too!")
    .clickEvent(SpongeComponents.executeCallback(
        cause -> cause.audience().sendMessage(Component.text("You clicked!"))));

Avec la méthode donnée ci-dessus, les joueurs peuvent cliquer sur « Click here! » pour lancer une certaine commande.

Note

Some text actions, such as ClickEvent#changePage(int), can only be used with book items.

Astuce

Comme pour les couleurs, plusieurs actions peuvent être ajoutées à un texte. Les actions de texte peuvent même être utilisée en tandem avec les couleurs grâce à l’interface de model de construction.

Sélecteurs

Les sélecteurs sont utilisés pour cibler des joueurs ou des entités qui remplissent certains critères. Les sélecteurs sont particulièrement utiles pour créer des plugins de mini-jeux, mais aussi pour beaucoup d’autres choses.

Astuce

Read this Minecraft wiki article for help understanding what target selectors are in Minecraft, and how to use them.

To use selectors in text, there is a component factory for Selectors. This is illustrated in the example below.

Exemple: Texte généré par Sélecteur

Component adventurers = Component.text("These players are in adventure mode: ")
        .append(Component.selector("@a[m=2]"));

In this example, the target selector @a[m=2] is targeting every online player who is in adventure mode. When the method is called, a Component will be returned with a selector of all the usernames of every online player who is in adventure mode. To send this selector to players, the selector will have to be expanded to the real usernames using SpongeComponents#resolve.

Text Builders

Mutable builder classes exist for every kind of Component. These are available should you need a mutable representation, and they are also used in a few convenience methods throughout the library to expose parts of an existing Component for editing.

Example: Text Component builder

Component weBuiltThisText = Component.text()
        .content("with Sponge and Flard")
        .color(NamedTextColor.YELLOW)
        .decorate(TextDecoration.ITALIC, TextDecoration.BOLD)
        .build()

Example: Editing text with a StyleBuilder

Component limitedEdition = weBuiltThisText.style(
        styleBuilder -> styleBuilder.decorate(TextDecoration.UNDERLINE));