📓Placeholders

Documentation pour l'API (Placeholders).

---

Gestion des placeholders

Introduction

Les placeholders sont essentiels pour vous faciliter la vie, si vous avez besoin d'en créer simplement et de les utiliser partout dans votre plugin. Grâce à la modularité de dAPI, vous pouvez facilement :

• Créer des placeholders textuels ou avec des valeurs définis dans votre code.

• Facilité de création et d'utilisation.

---

Création d'un placeholders

Étape 1 : Importer Placeholders

Pour commencer, importez la classe Placeholders dans votre projet :

import fr.kirosnn.dAPI.utils.Placeholders;

---

Étape 2 : Initialisation

Dans la classe principale de votre plugin ou bien une classe dédiée, initialisez vos placeholders dans le constructeur ou la méthode onEnable :

Placeholders.setPlaceholder(String key, Object value);

Note : La valeur peut être n'importe quoi, un nombre, un texte ou une valeur défini dans votre code.

Exemple tout simple :

Placeholders.setPlaceholder("%server_name%", "Wiloria");

Comme ceci, le placeholder %server_name% sera utilisable partout dans votre plugin uniquement, il n'y a pas de fonctionnalité comme dans PlaceholderAPI pour pouvoir être utilisé même en dehors du plugin.

---

Utilisation d'un placeholders

Étape 1 : Récupérer la valeur d’un placeholder

Obtenez la valeur associée à une clé de placeholder.

Syntaxe :

Object value = Placeholders.getPlaceholder(String key);

Paramètres :

• key : La clé du placeholder (exemple : %server_name%).

Retourne :

• La valeur associée si elle existe.

• null si le placeholder n’existe pas.

Exemple :

String serverName = (String) Placeholders.getPlaceholder("%server_name%");

---

Étape 2 : Vérifier l’existence d’un placeholder

Vérifiez si un placeholder spécifique existe dans la liste.

Syntaxe :

boolean exists = Placeholders.hasPlaceholder(String key);

Paramètres :

• key : La clé du placeholder.

Retourne :

• true si le placeholder existe.

• false sinon.

Exemple :

if (Placeholders.hasPlaceholder("%server_name%")) {
    System.out.println("Le placeholder existe !");
}

---

Étape 3 : Supprimer un placeholder

Supprimez un placeholder existant.

Syntaxe :

Placeholders.removePlaceholder(String key);

Paramètres :

• key : La clé du placeholder à supprimer.

Exemple :

Placeholders.removePlaceholder("%server_name%");

---

Lecture

Méthode	Description
getPlaceholder(String key)	Récupère la valeur associée à un placeholder ou null s'il n'existe pas.
hasPlaceholder(String key)	Vérifie si un placeholder existe (retourne un booléen).

Écriture

Méthode	Description
setPlaceholder(String key, Object value)	Ajoute ou met à jour un placeholder avec la valeur spécifiée.
removePlaceholder(String key)	Supprime un placeholder existant.

---

Exemple complet

Voici un exemple d’utilisation des fonctionnalités de la classe Placeholders dans un plugin :

import fr.kirosnn.dAPI.utils.Placeholders;

public class PlaceholderExample {

    public static void main(String[] args) {
        // Ajout de placeholders
        Placeholders.setPlaceholder("%player%", "Steve");
        Placeholders.setPlaceholder("%server_name%", "MyAwesomeServer");

        // Utilisation des placeholders
        if (Placeholders.hasPlaceholder("%server_name%")) {
            String message = String.format("Bienvenue sur %s, %s !",
                    Placeholders.getPlaceholder("%server_name%"),
                    Placeholders.getPlaceholder("%player%")
            );
            System.out.println(message);
        }

        // Suppression d'un placeholder
        Placeholders.removePlaceholder("%player%");
    }
}

---

Méthodes disponibles

Lecture

Méthode	Description
getPlaceholder(String key)	Récupère la valeur associée à un placeholder ou null s'il n'existe pas.
hasPlaceholder(String key)	Vérifie si un placeholder existe (retourne un booléen).

Écriture

Méthode	Description
setPlaceholder(String key, Object value)	Ajoute ou met à jour un placeholder avec la valeur spécifiée.
removePlaceholder(String key)	Supprime un placeholder existant.

---

Je suis sûr que ça simplifiera votre vie de codeur ✨.