diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ed35b23 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# Gradle +.gradle/ +build/ +!gradle/wrapper/gradle-wrapper.jar + +# IDE +.idea/ +*.iml +*.iws +*.ipr +out/ +.vscode/ + +# OS / Misc +.DS_Store +Thumbs.db +*.log diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 0000000..98087d6 --- /dev/null +++ b/GEMINI.md @@ -0,0 +1,23 @@ +# Directives & Architecture du Projet betterMcGuis + +## 🎯 Objectif +`betterMcGuis` est une bibliothĂšque Java moderne, fluide et Ă©vĂ©nementielle pour la crĂ©ation dynamique d'interfaces graphiques (GUIs / Menus interactifs / Inventaires) sur serveurs Minecraft Paper et Spigot (1.20.4+). + +## 🌟 Principes ClĂ©s +1. **DSL Fluide & DĂ©claratif** : CrĂ©ation chainable d'inventaires (Coffres 1-6 lignes, Hoppers, Distributeurs, Enclumes). +2. **ItemBuilder Riches** : Prise en charge native de MiniMessage, enchantements, flags, tĂȘtes de joueurs, armures teintĂ©es, CustomModelData et PDC. +3. **SystĂšme de Layouts / Patterns** : DĂ©finition visuelle des inventaires par matrice de caractĂšres (ASCII Masks / Patterns). +4. **Types de GUIs AvancĂ©s** : + - GUI Simple (`Gui`) + - GUI PaginĂ© (`PaginatedGui`) + - GUI DĂ©filant (`ScrollableGui`) + - GUI Ă  Onglets (`TabbedGui`) + - GUI AnimĂ© (`AnimatedGui`) + - GUI avec zones d'interaction / coffre de dĂ©pĂŽt (`StorageGui` / `EditableSlots`) +5. **Gestionnaire d'ÉvĂ©nements & Cycle de Vie** : + - ÉvĂ©nements complets : `GuiOpenEvent`, `GuiCloseEvent`, `GuiClickEvent`, `GuiPageChangeEvent`, `GuiRefreshEvent`. + - Hooks locaux (`.onOpen()`, `.onClose()`, `.onClick()`) et Ă©couteurs globaux annotĂ©s `@GuiEventHandler`. +6. **Protection contre les Glitches** : + - Annulation sĂ©curisĂ©e des clics, shift-clicks, drag-and-drop et Ă©changes rapides (Hotbar swap). + - Nettoyage automatique des Ă©tats lors de la dĂ©connexion ou fermeture de l'inventaire. +7. **IndĂ©pendance & TestabilitĂ©** : Classes mĂ©tier dĂ©couplĂ©es du moteur Minecraft pour des tests unitaires rapides et fiables. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..16b160c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Luc Rival / GeminiAntigravityCLI + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index efc1051..35f109d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,359 @@ -# betterMcGuis +# đŸ–Œïž betterMcGuis -Bibliotheque Java moderne, fluide et evenementielle pour la creation dynamique de GUIs et menus interactifs Minecraft Paper/Spigot. \ No newline at end of file +[![Java](https://img.shields.io/badge/Java-17%2B%20%2F%2021-orange.svg)](https://www.oracle.com/java/) +[![Paper](https://img.shields.io/badge/Paper-1.20.4%2B-blue.svg)](https://papermc.io/) +[![Kyori Adventure](https://img.shields.io/badge/Adventure-MiniMessage-purple.svg)](https://docs.advntr.dev/) +[![License](https://img.shields.io/badge/License-MIT-green.svg)](#) + +Une bibliothĂšque Java moderne, fluide et Ă©vĂ©nementielle permettant de crĂ©er, animer et gĂ©rer des interfaces graphiques (GUIs / Menus interactifs / Inventaires) sur serveurs Minecraft Paper et Spigot (1.20.4+). + +--- + +## 📑 Sommaire +- [📚 Guides DĂ©taillĂ©s (Dossier `/docs`)](#-guides-dĂ©taillĂ©s-dossier-docs) +- [🌟 FonctionnalitĂ©s](#-fonctionnalitĂ©s) +- [đŸ—ïž Architecture & Flux d'Interactions](#-architecture--flux-dinteractions) +- [📩 Installation & Configuration](#-installation--configuration) +- [🚀 Guide de DĂ©marrage Rapide](#-guide-de-dĂ©marrage-rapide) +- [💡 Exemples de Menus](#-exemples-de-menus) + - [1. Menu Principal Standard (`GuiBuilder`)](#1-menu-principal-standard-guibuilder) + - [2. Menu PaginĂ© Dynamique (`PaginatedGui`)](#2-menu-paginĂ©-dynamique-paginatedgui) + - [3. Motifs ASCII & Grilles de Disposition (`GuiPattern`)](#3-motifs-ascii--grilles-de-disposition-guipattern) + - [4. Menus Ă  Onglets sans RĂ©ouverture (`TabbedGui`)](#4-menus-Ă -onglets-sans-rĂ©ouverture-tabbedgui) + - [5. Zones de DĂ©pĂŽt / Poubelle (`StorageGui`)](#5-zones-de-dĂ©pĂŽt--poubelle-storagegui) +- [💎 Construction d'Items (`ItemBuilder`)](#-construction-ditems-itembuilder) +- [🎯 SystĂšme d'ÉvĂ©nements & Écouteurs AnnotĂ©s](#-systĂšme-dĂ©vĂ©nements--Ă©couteurs-annotĂ©s) +- [📂 Organisation des Packages](#-organisation-des-packages) + +--- + +## 📚 Guides DĂ©taillĂ©s (Dossier `/docs`) + +Pour une exploration approfondie de chaque composant, consultez la documentation modulaire : +* 📘 [**01. Guide de DĂ©marrage Rapide**](docs/01_GETTING_STARTED.md) : Installation Gradle/Maven, initialisation dans `JavaPlugin` et cycle de vie. +* đŸ—ïž [**02. Fluent GUI Builder DSL**](docs/02_GUI_BUILDER_DSL.md) : MĂ©thodes de placement de slots, dimensions, bordures, remplissages et propriĂ©tĂ©s dynamiques. +* 💎 [**03. ItemBuilder & GuiItem**](docs/03_ITEM_BUILDER_AND_ITEMS.md) : Formatage MiniMessage, tĂȘtes personnalisĂ©es, armures teintĂ©es, sons, cooldowns et `GuiClickContext`. +* 🎹 [**04. Motifs & Masques ASCII**](docs/04_PATTERNS_AND_MASKS.md) : Conception visuelle de grilles par matrices textuelles (`GuiPattern`, `GuiMask`). +* 📚 [**05. Menus PaginĂ©s, Onglets & Animations**](docs/05_PAGINATED_AND_ADVANCED_GUIS.md) : Pagination automatique, onglets commutables sans rĂ©ouverture et frames animĂ©es. +* 🎯 [**06. Cycle de Vie & ÉvĂ©nements**](docs/06_LIFECYCLE_AND_EVENTS.md) : Hooks locaux (`.onClick()`, `.onClose()`) et Ă©couteurs globaux annotĂ©s `@GuiEventHandler`. +* 📩 [**07. Zones de Stockage & Slots Éditables**](docs/07_STORAGE_AND_EDITABLE_SLOTS.md) : Menus de dĂ©pĂŽts, restitution d'items et sĂ©curitĂ©s anti-glitch. + +--- + +## 🌟 FonctionnalitĂ©s + +- **DSL Fluide & DĂ©claratif** : Construction rapide et lisible (`BetterMcGuis.builder("Titre", 3)`). +- **Formatage Moderne MiniMessage & Adventure** : Prise en charge native des gradients HEX, balises de style et composants texte. +- **Grilles & Motifs ASCII (`GuiPattern`)** : Dessinez vos interfaces directement en texte sous forme de matrice avec associations de caractĂšres. +- **Pagination Intelligente (`PaginatedGui`)** : Calcul automatique des pages, boutons de navigation dynamiques et indicateurs de progression. +- **Onglets Commutables (`TabbedGui`)** : Basculez entre plusieurs vues de menu instantanĂ©ment sans fermer la fenĂȘtre du joueur. +- **Animations CadencĂ©es (`AnimatedGui`)** : Lecture de sĂ©quences de frames temporelles (titres animĂ©s, coffres mystĂšres, carrousels). +- **Protection Anti-Duplication & SĂ©curitĂ©** : Blocage natif et sĂ©curisĂ© des vols d'items, glisser-dĂ©poser illĂ©gaux, shift-clics et raccourcis de hotbar. +- **Moteur d'ÉvĂ©nements Riches** : Bus d'Ă©vĂ©nements global avec prioritĂ©s et annotations `@GuiEventHandler`. + +--- + +## đŸ—ïž Architecture & Flux d'Interactions + +```mermaid +flowchart TD + Player["Joueur en Jeu"] -->|Effectue un Clic / Drag / Fermeture| BukkitEvt["BukkitGuiEventListener (SĂ©curitĂ© & Interception)"] + + BukkitEvt --> HolderCheck{"Inventaire liĂ© Ă  BetterGuiHolder ?"} + HolderCheck -- Non --> Ignore["Ignore l'interaction"] + + HolderCheck -- Oui --> SlotTypeCheck{"Localisation du Clic"} + + SlotTypeCheck -- ExtĂ©rieur (-999) --> OutsideHook["gui.handleOutsideClick() & GuiClickEvent"] + SlotTypeCheck -- Inventaire Joueur --> BottomCheck{"Shift-Clic ou Hotbar Swap vers slot protĂ©gĂ© ?"} + BottomCheck -- Oui --> BlockShift["event.setCancelled(true) & Blocage"] + BottomCheck -- Non --> BottomHook["gui.handleBottomClick()"] + + SlotTypeCheck -- Inventaire SupĂ©rieur (GUI) --> EditCheck{"Le Slot est-il Editable ?"} + EditCheck -- Non (DĂ©faut) --> CancelDef["event.setCancelled(true) (EmpĂȘche le vol)"] + EditCheck -- Oui --> AllowEdit["event.setCancelled(false) (Autorise le dĂ©pĂŽt)"] + + CancelDef --> CoolCheck{"Cooldown Actif sur l'Item ?"} + AllowEdit --> CoolCheck + + CoolCheck -- Oui --> CoolBlock["Interruption silencieuse"] + CoolCheck -- Non --> SoundTrigger["DĂ©clenchement du Son configurĂ©"] + + SoundTrigger --> ItemAction["ExĂ©cution de l'Action MĂ©tier (item.handleClick)"] + ItemAction --> GuiHook["ExĂ©cution du Hook Local (gui.handleClick)"] + GuiHook --> EventBus["Diffusion sur le Bus Global (GuiClickEvent)"] +``` + +--- + +## 📩 Installation & Configuration + +### Gradle (Kotlin DSL) + +```kotlin +repositories { + mavenCentral() + maven("https://repo.papermc.io/repository/maven-public/") +} + +dependencies { + implementation("fr.luc:betterMcGuis:1.0.0-SNAPSHOT") +} +``` + +--- + +## 🚀 Guide de DĂ©marrage Rapide + +### 1. Initialisation dans votre `JavaPlugin` + +```java +package fr.luc.monplugin; + +import fr.luc.bettermcguis.BetterMcGuis; +import org.bukkit.plugin.java.JavaPlugin; + +public class MonPlugin extends JavaPlugin { + + private BetterMcGuis guiManager; + + @Override + public void onEnable() { + // Initialisation de betterMcGuis (enregistre automatiquement les Ă©couteurs Bukkit) + this.guiManager = BetterMcGuis.create(this); + + // Enregistrement d'Ă©couteurs annotĂ©s globaux (optionnel) + this.guiManager.registerListeners(new MonEcouteurDeGui()); + } + + @Override + public void onDisable() { + // Nettoyage complet + if (guiManager != null) { + guiManager.unregisterAll(); + } + } +} +``` + +--- + +## 💡 Exemples de Menus + +### 1. Menu Principal Standard (`GuiBuilder`) + +```java +BetterMcGuis.builder() + .title("Menu Principal") + .rows(3) + .fillBorder(Material.BLACK_STAINED_GLASS_PANE) + + // Bouton central interactif + .item(13, BetterMcGuis.item(Material.NETHER_STAR) + .name("RĂ©compense Quotidienne") + .lore( + "RĂ©cupĂ©rez votre bonus de connexion !", + "", + "▶ Cliquez pour rĂ©clamer" + ) + .glowing(true) + .asGuiItem(ctx -> { + ctx.playSound(Sound.ENTITY_PLAYER_LEVELUP, 1.0f, 1.2f); + ctx.replySuccess("Bonus rĂ©clamĂ© avec succĂšs !"); + ctx.close(); + }) + ) + .build() + .open(player); +``` + +--- + +### 2. Menu PaginĂ© Dynamique (`PaginatedGui`) + +```java +var shop = BetterMcGuis.paginated() + .title("Boutique du Serveur") + .rows(5) + .fillBorder(Material.GRAY_STAINED_GLASS_PANE); + +// Ajout de 50 articles dans le catalogue paginĂ© +for (int i = 1; i <= 50; i++) { + int id = i; + shop.addPageItem(BetterMcGuis.item(Material.DIAMOND) + .name("Article #" + id + "") + .lore("Prix : 100 $") + .asGuiItem(ctx -> { + ctx.replySuccess("Achat de l'article #" + id + " validĂ© !"); + }) + ); +} + +shop.build().open(player); +``` + +--- + +### 3. Motifs ASCII & Grilles de Disposition (`GuiPattern`) + +```java +BetterMcGuis.builder("Menu QuĂȘtes", 5) + .pattern(p -> p + .lines( + "#########", + "# 1 2 3 #", + "# #", + "# C #", + "#########" + ) + .bindFiller('#', Material.BLACK_STAINED_GLASS_PANE) + .bind('1', BetterMcGuis.item(Material.BOOK).name("QuĂȘte Facile").asGuiItem()) + .bind('2', BetterMcGuis.item(Material.WRITABLE_BOOK).name("QuĂȘte Moyenne").asGuiItem()) + .bind('3', BetterMcGuis.item(Material.ENCHANTED_BOOK).name("QuĂȘte Difficile").asGuiItem()) + .bind('C', BetterMcGuis.item(Material.BARRIER).name("Fermer").asGuiItem(GuiClickContext::close)) + ) + .build() + .open(player); +``` + +--- + +### 4. Menus Ă  Onglets sans RĂ©ouverture (`TabbedGui`) + +```java +BetterMcGuis.tabbed("Menu Profil", 4) + // Onglet 1 : Statistiques + .tab("stats", 11, BetterMcGuis.item(Material.PAPER).name("Statistiques").asGuiItem(), tab -> { + tab.setTabItem("stats", 22, BetterMcGuis.item(Material.EXPERIENCE_BOTTLE).name("Niveau 42").asGuiItem()); + }) + // Onglet 2 : RĂ©compenses + .tab("rewards", 15, BetterMcGuis.item(Material.CHEST).name("RĂ©compenses").asGuiItem(), tab -> { + tab.setTabItem("rewards", 22, BetterMcGuis.item(Material.GOLD_INGOT).name("Bonus DĂ©bloquĂ©").asGuiItem()); + }) + .build() + .open(player); +``` + +--- + +### 5. Zones de DĂ©pĂŽt / Poubelle (`StorageGui`) + +```java +StorageGui trash = new StorageGui("Poubelle Publique", GuiType.CHEST_4_ROWS); +trash.fillBorder(Material.RED_STAINED_GLASS_PANE); +trash.setStorageSlots(SlotRange.interior(4, 9)); +trash.returnItemsOnClose(false); // DĂ©truit dĂ©finitivement les objets dĂ©posĂ©s +trash.open(player); +``` + +--- + +## 💎 Construction d'Items (`ItemBuilder`) + +```java +ItemStack item = BetterMcGuis.item(Material.DIAMOND_HELMET) + .name("Casque de Diamant Divin") + .lore( + "ForgĂ© par les anciens dieux.", + "", + "Protection : IV" + ) + .enchant(Enchantment.PROTECTION_ENVIRONMENTAL, 4) + .unbreakable(true) + .customModelData(2005) + .glowing(true) + .build(); +``` + +--- + +## 🎯 SystĂšme d'ÉvĂ©nements & Écouteurs AnnotĂ©s + +```java +package fr.luc.monplugin.listener; + +import fr.luc.bettermcguis.event.*; +import fr.luc.bettermcguis.event.annotation.GuiEventHandler; + +public class MonEcouteurGlobalGui { + + @GuiEventHandler(priority = 10) + public void onGuiClick(GuiClickEvent event) { + var ctx = event.getContext(); + System.out.println("[GUI] Clic de " + ctx.getPlayer().getName() + " sur le slot #" + ctx.getSlot()); + } + + @GuiEventHandler + public void onGuiClose(GuiCloseEvent event) { + System.out.println("[GUI] Fermeture du menu : " + event.getGui().getTitle()); + } +} +``` + +--- + +## 📂 Organisation des Packages + +``` +fr.luc.bettermcguis/ + ├── BetterMcGuis.java (Façade principale & Enregistrement) + ├── api/ (Contrats et modĂšles publics) + │ ├── Gui.java (Interface de base de tout GUI) + │ ├── GuiType.java (Types de coffres 1-6 et types Bukkit) + │ ├── GuiItem.java (Items interactifs, cooldowns, sons, visibilitĂ©) + │ ├── GuiClickAction.java (Callback fonctionnel de clic) + │ ├── GuiClickContext.java (Contexte complet de clic) + │ ├── GuiOpenContext.java (Contexte d'ouverture) + │ ├── GuiCloseContext.java (Contexte de fermeture) + │ └── slot/ + │ ├── SlotPos.java (Position ligne, colonne) + │ └── SlotRange.java (Bordures, intĂ©rieurs, plages) + ├── builder/ (Constructeurs fluides) + │ ├── ItemBuilder.java (CrĂ©ation d'ItemStacks riches avec Adventure) + │ ├── GuiBuilder.java (Constructeur de menus standards) + │ ├── PaginatedGuiBuilder.java (Constructeur de menus paginĂ©s) + │ ├── TabbedGuiBuilder.java (Constructeur de menus Ă  onglets) + │ ├── AnimatedGuiBuilder.java (Constructeur de menus animĂ©s) + │ └── PatternBuilder.java (Constructeur de motifs ASCII) + ├── pattern/ (Moteur de disposition par grilles ASCII) + │ ├── GuiPattern.java + │ └── GuiMask.java + ├── type/ (ImplĂ©mentations de GUIs) + │ ├── SimpleGui.java + │ ├── PaginatedGui.java + │ ├── TabbedGui.java + │ ├── AnimatedGui.java + │ └── StorageGui.java + ├── animation/ (Moteur d'animation) + │ └── Frame.java + ├── event/ (Bus d'Ă©vĂ©nements & Lifecycle) + │ ├── GuiEvent.java + │ ├── CancellableGuiEvent.java + │ ├── GuiOpenEvent.java + │ ├── GuiCloseEvent.java + │ ├── GuiClickEvent.java + │ ├── GuiPageChangeEvent.java + │ ├── GuiRefreshEvent.java + │ ├── GuiEventManager.java + │ ├── GuiEventListener.java + │ └── annotation/ + │ └── GuiEventHandler.java + ├── holder/ (Liaison avec InventoryHolder de Bukkit) + │ └── BetterGuiHolder.java + ├── listener/ (Interception Bukkit & SĂ©curitĂ©s anti-glitch) + │ └── BukkitGuiEventListener.java + └── demo/ (DĂ©monstrations et plugin de test) + ├── DemoGuiPlugin.java + ├── guis/ + │ ├── DemoMainMenuGui.java + │ ├── DemoPaginatedShopGui.java + │ └── DemoStorageTrashGui.java + └── listeners/ + └── DemoGuiListener.java +``` + +--- + +## 📄 Licence + +Ce projet est sous licence [MIT](LICENSE). \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..000064d --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,77 @@ +plugins { + `java-library` + `maven-publish` + id("com.gradleup.shadow") version "8.3.6" +} + +group = "fr.luc" +version = "1.0.0-SNAPSHOT" + +repositories { + mavenCentral() + maven("https://repo.papermc.io/repository/maven-public/") + maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") + maven("https://oss.sonatype.org/content/groups/public/") + maven("https://jitpack.io") +} + +dependencies { + // Paper API 1.20.4 (Fournit Bukkit, InventoryHolder et Adventure natif) + compileOnly("io.papermc.paper:paper-api:1.20.4-R0.1-SNAPSHOT") + + // Kyori Adventure & MiniMessage + compileOnly("net.kyori:adventure-api:4.17.0") + compileOnly("net.kyori:adventure-text-minimessage:4.17.0") + + // Tests unitaires JUnit 5 & Mockito + testImplementation(platform("org.junit:junit-bom:5.10.2")) + testImplementation("org.junit.jupiter:junit-jupiter") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") + testImplementation("org.mockito:mockito-core:5.11.0") + testImplementation("org.mockito:mockito-junit-jupiter:5.11.0") + + // Paper API et Adventure dans les tests unitaires + testImplementation("io.papermc.paper:paper-api:1.20.4-R0.1-SNAPSHOT") + testImplementation("net.kyori:adventure-api:4.17.0") + testImplementation("net.kyori:adventure-text-minimessage:4.17.0") +} + +java { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 + withSourcesJar() + withJavadocJar() +} + +tasks.withType { + options.encoding = "UTF-8" + options.release.set(17) +} + +tasks.withType { + options.encoding = "UTF-8" + (options as StandardJavadocDocletOptions).apply { + addStringOption("Xdoclint:none", "-quiet") + encoding = "UTF-8" + charSet = "UTF-8" + } +} + +tasks.shadowJar { + archiveClassifier.set("") +} + +tasks.build { + dependsOn(tasks.shadowJar) +} + +publishing { + publications { + create("mavenJava") { + from(components["java"]) + groupId = "fr.luc" + artifactId = "betterMcGuis" + version = "1.0.0-SNAPSHOT" + } + } +} diff --git a/docs/01_GETTING_STARTED.md b/docs/01_GETTING_STARTED.md new file mode 100644 index 0000000..0e123e3 --- /dev/null +++ b/docs/01_GETTING_STARTED.md @@ -0,0 +1,89 @@ +# 🚀 Guide de DĂ©marrage Rapide - betterMcGuis + +Ce guide vous accompagne dans l'installation, la configuration et la crĂ©ation de vos premiĂšres interfaces graphiques interactives (GUIs) avec la bibliothĂšque **betterMcGuis**. + +--- + +## 📩 1. Installation + +### Gradle (Kotlin DSL) + +Ajoutez les dĂ©pĂŽts et la dĂ©pendance dans votre fichier `build.gradle.kts` : + +```kotlin +repositories { + mavenCentral() + maven("https://repo.papermc.io/repository/maven-public/") +} + +dependencies { + // IntĂ©gration de betterMcGuis + implementation("fr.luc:betterMcGuis:1.0.0-SNAPSHOT") +} +``` + +--- + +## ⚙ 2. Initialisation dans votre Plugin Bukkit/Paper + +CrĂ©ez une instance de `BetterMcGuis` dans la mĂ©thode `onEnable()` de votre plugin et nettoyez-la proprement dans `onDisable()` : + +```java +package fr.luc.monplugin; + +import fr.luc.bettermcguis.BetterMcGuis; +import org.bukkit.plugin.java.JavaPlugin; + +public class MonPlugin extends JavaPlugin { + + private BetterMcGuis guiManager; + + @Override + public void onEnable() { + // 1. Initialisation du gestionnaire et enregistrement automatique des Ă©couteurs Bukkit + this.guiManager = BetterMcGuis.create(this); + + // 2. Enregistrement d'Ă©couteurs d'Ă©vĂ©nements globaux (optionnel) + this.guiManager.registerListeners(new MonEcouteurDeGui()); + + getLogger().info("betterMcGuis est prĂȘt !"); + } + + @Override + public void onDisable() { + // 3. Nettoyage des Ă©couteurs et suppression des ressources + if (guiManager != null) { + guiManager.unregisterAll(); + } + } +} +``` + +--- + +## 💡 3. Votre Premier Menu en 5 Lignes + +```java +public void ouvrirMenuBienvenue(Player player) { + BetterMcGuis.builder() + .title("Menu de Bienvenue") + .rows(3) + .fillBorder(Material.BLACK_STAINED_GLASS_PANE) + .item(13, BetterMcGuis.item(Material.DIAMOND) + .name("RĂ©clamer le Cadeau") + .lore("Cliquez pour recevoir 1 Diamant gratuit !") + .glowing(true) + .asGuiItem(ctx -> { + ctx.getPlayer().getInventory().addItem(new ItemStack(Material.DIAMOND)); + ctx.replySuccess("Diamant reçu avec succĂšs !"); + ctx.close(); + }) + ) + .build() + .open(player); +} +``` + +--- + +> 📖 **Étape suivante** : DĂ©couvrez la syntaxe complĂšte du constructeur dans [02_GUI_BUILDER_DSL.md](02_GUI_BUILDER_DSL.md). diff --git a/docs/02_GUI_BUILDER_DSL.md b/docs/02_GUI_BUILDER_DSL.md new file mode 100644 index 0000000..81ac511 --- /dev/null +++ b/docs/02_GUI_BUILDER_DSL.md @@ -0,0 +1,94 @@ +# đŸ—ïž Fluent GUI Builder DSL - betterMcGuis + +La crĂ©ation de menus repose sur un pattern **Builder chainable, fluide et modulaire**. + +--- + +## 📑 Sommaire +- [1. Configuration des Dimensions et Types d'Inventaires](#1-configuration-des-dimensions-et-types-dinventaires) +- [2. Placement des Items](#2-placement-des-items) +- [3. Remplissage et Bordures](#3-remplissage-et-bordures) +- [4. PropriĂ©tĂ©s Dynamiques](#4-propriĂ©tĂ©s-dynamiques) +- [5. ContrĂŽle du Cycle de Vie et Ouvertures](#5-contrĂŽle-du-cycle-de-vie-et-ouvertures) + +--- + +## 1. Configuration des Dimensions et Types d'Inventaires + +Vous pouvez configurer des coffres standards de 1 Ă  6 lignes, ou des types d'inventaires Bukkit spĂ©cifiques : + +```java +// Coffre 3 lignes (27 slots) +BetterMcGuis.builder("Titre", 3); + +// Types spĂ©cifiques via GuiType +BetterMcGuis.builder() + .title("Distributeur") + .type(GuiType.DISPENSER); // DISPENSER, DROPPER, HOPPER, ANVIL, WORKBENCH, BREWING +``` + +--- + +## 2. Placement des Items + +Vous pouvez positionner des items selon trois mĂ©thodes d'adressage : + +```java +var builder = BetterMcGuis.builder("Exemple", 4); + +// Par slot absolu (0-indexĂ©, 0 Ă  35) +builder.item(13, monItem); + +// Par coordonnĂ©es ligne/colonne (0-indexĂ©, ligne 1, col 4) +builder.item(1, 4, monItem); + +// Par SlotPos +builder.item(SlotPos.of(1, 4), monItem); +``` + +--- + +## 3. Remplissage et Bordures + +Des mĂ©thodes utilitaires permettent de remplir instantanĂ©ment l'inventaire ou ses contours : + +```java +// Remplit toutes les bordures extĂ©rieures avec du vitrage teintĂ© +builder.fillBorder(Material.GRAY_STAINED_GLASS_PANE); + +// Remplit une plage continue de slots +builder.fillRange(SlotRange.of(10, 16), monItem); + +// Remplit tout l'inventaire +builder.fill(monItem); +``` + +--- + +## 4. PropriĂ©tĂ©s Dynamiques + +Vous pouvez attacher des donnĂ©es arbitraires Ă  l'instance de GUI pour les partager entre callbacks : + +```java +Gui gui = BetterMcGuis.builder("Profil", 3) + .property("targetPlayerUuid", target.getUniqueId()) + .property("openedAt", System.currentTimeMillis()) + .build(); + +// RĂ©cupĂ©ration typĂ©e dans un callback +UUID uuid = gui.getProperty("targetPlayerUuid", UUID.class); +``` + +--- + +## 5. ContrĂŽle du Cycle de Vie et Ouvertures + +* `gui.open(Player)` : Ouvre l'inventaire pour le joueur. +* `gui.close(Player)` : Ferme l'inventaire. +* `gui.refresh(Player)` : Met Ă  jour visuellement les items sans rĂ©ouverture. +* `gui.refreshAll()` : RafraĂźchit l'affichage pour tous les spectateurs actifs. +* `gui.setTitle("Nouveau Titre")` : Modifie le titre du menu. + +--- + +> 📖 **Étape suivante** : DĂ©couvrez la crĂ©ation d'items avec [03_ITEM_BUILDER_AND_ITEMS.md](03_ITEM_BUILDER_AND_ITEMS.md). diff --git a/docs/03_ITEM_BUILDER_AND_ITEMS.md b/docs/03_ITEM_BUILDER_AND_ITEMS.md new file mode 100644 index 0000000..c7ce91d --- /dev/null +++ b/docs/03_ITEM_BUILDER_AND_ITEMS.md @@ -0,0 +1,111 @@ +# 💎 ItemBuilder & GuiItem - betterMcGuis + +La crĂ©ation et l'interaction avec les items Minecraft sont grandement simplifiĂ©es grĂące Ă  `ItemBuilder` et `GuiItem`. + +--- + +## 📑 Sommaire +- [1. CrĂ©ation d'ItemStacks avec `ItemBuilder`](#1-crĂ©ation-ditemstacks-avec-itembuilder) +- [2. Prise en Charge de MiniMessage et Kyori Adventure](#2-prise-en-charge-de-minimessage-et-kyori-adventure) +- [3. TĂȘtes PersonnalisĂ©es, Couleurs et Flags](#3-tĂȘtes-personnalisĂ©es-couleurs-et-flags) +- [4. L'Objet Interactif `GuiItem`](#4-lobjet-interactif-guiitem) +- [5. Le Contexte de Clic (`GuiClickContext`)](#5-le-contexte-de-clic-guiclickcontext) + +--- + +## 1. CrĂ©ation d'ItemStacks avec `ItemBuilder` + +```java +ItemStack epee = ItemBuilder.of(Material.DIAMOND_SWORD) + .name("Lame des Enfers") + .lore( + "Une Ă©pĂ©e forgĂ©e dans les profondeurs du Nether.", + "", + "DĂ©gĂąts : +15", + "Effet : Enflamme les cibles" + ) + .amount(1) + .enchant(Enchantment.DAMAGE_ALL, 5) + .enchant(Enchantment.FIRE_ASPECT, 2) + .unbreakable(true) + .flags(ItemFlag.HIDE_UNBREAKABLE) + .customModelData(1001) + .build(); +``` + +--- + +## 2. Prise en Charge de MiniMessage et Kyori Adventure + +Tous les noms et lores utilisent nativement les balises MiniMessage : +* `Texte` : DĂ©gradĂ©s de couleurs HEX. +* ``, ``, ``, `` : Mises en forme. +* `Texte Arc-en-ciel` : Animation multicolore. +* ``, ``, ``, ``, ``, etc. + +--- + +## 3. TĂȘtes PersonnalisĂ©es, Couleurs et Flags + +```java +// TĂȘte de joueur par pseudo ou UUID +GuiItem tete = ItemBuilder.skull() + .skullOwner("Luc") + .name("Profil de Luc") + .asGuiItem(); + +// Armure en cuir teintĂ©e +ItemStack armure = ItemBuilder.of(Material.LEATHER_CHESTPLATE) + .color(Color.fromRGB(41, 128, 185)) + .build(); + +// Item brillant sans texte d'enchantement +GuiItem etoile = ItemBuilder.of(Material.NETHER_STAR) + .glowing(true) + .asGuiItem(); +``` + +--- + +## 4. L'Objet Interactif `GuiItem` + +Un `GuiItem` encapsule un `ItemStack` avec des comportements avancĂ©s : + +```java +GuiItem bouton = ItemBuilder.of(Material.EMERALD) + .name("Confirmer l'achat") + .asGuiItem(ctx -> { + ctx.replySuccess("Achat confirmĂ© !"); + }) + // Condition de visibilitĂ© : seuls les joueurs avec la permission voient cet item + .visibleIf(player -> player.hasPermission("monplugin.vip")) + // Cooldown de 2 secondes entre les clics + .cooldown(Duration.ofSeconds(2)) + // Joue un son au joueur + .sound(Sound.ENTITY_PLAYER_LEVELUP, 1.0f, 1.2f) + // Ferme l'inventaire aprĂšs le clic + .closeOnClick(); +``` + +--- + +## 5. Le Contexte de Clic (`GuiClickContext`) + +| MĂ©thode | Description | +|---|---| +| `ctx.getPlayer()` | RĂ©cupĂšre le joueur ayant cliquĂ©. | +| `ctx.getSlot()` | RĂ©cupĂšre l'index du slot absolu cliquĂ©. | +| `ctx.getSlotPos()` | RĂ©cupĂšre la position (ligne, colonne). | +| `ctx.getClickType()` | RĂ©cupĂšre le type de clic (`LEFT`, `RIGHT`, `SHIFT_LEFT`, etc.). | +| `ctx.isLeftClick()` / `isRightClick()` | Raccourcis boolĂ©ens pour tester le type de clic. | +| `ctx.isShiftClick()` | Teste si la touche Shift Ă©tait enfoncĂ©e. | +| `ctx.close()` | Ferme l'inventaire actuel. | +| `ctx.refresh()` | RafraĂźchit les items du menu. | +| `ctx.playSound(sound, vol, pitch)` | Joue un son de confirmation ou d'erreur. | +| `ctx.reply("Message")`| Envoie un message formatĂ© en MiniMessage. | +| `ctx.replySuccess(msg)` | Envoie un message de succĂšs prĂ©fixĂ© en vert. | +| `ctx.replyError(msg)` | Envoie un message d'erreur prĂ©fixĂ© en rouge. | + +--- + +> 📖 **Étape suivante** : Apprenez Ă  concevoir des grilles avec [04_PATTERNS_AND_MASKS.md](04_PATTERNS_AND_MASKS.md). diff --git a/docs/04_PATTERNS_AND_MASKS.md b/docs/04_PATTERNS_AND_MASKS.md new file mode 100644 index 0000000..52b1f7c --- /dev/null +++ b/docs/04_PATTERNS_AND_MASKS.md @@ -0,0 +1,82 @@ +# 🎹 Motifs & Masques ASCII - betterMcGuis + +La crĂ©ation de mises en page complexes est grandement facilitĂ©e par le systĂšme de **Motifs (Patterns)** et **Masques (Masks)** textuels. + +--- + +## 📑 Sommaire +- [1. Qu'est-ce qu'un Motif ASCII (`GuiPattern`) ?](#1-quest-ce-quun-motif-ascii-guipattern-) +- [2. DĂ©claration et Utilisation](#2-dĂ©claration-et-utilisation) +- [3. Masques de SĂ©lection de Slots (`GuiMask`)](#3-masques-de-sĂ©lection-de-slots-guimask) + +--- + +## 1. Qu'est-ce qu'un Motif ASCII (`GuiPattern`) ? + +Un `GuiPattern` vous permet de dessiner littĂ©ralement la disposition visuelle de votre inventaire sous forme de lignes de texte, oĂč chaque caractĂšre reprĂ©sente un type d'item. + +--- + +## 2. DĂ©claration et Utilisation + +```java +GuiPattern pattern = BetterMcGuis.pattern( + "#########", + "# S K Q #", + "# #", + "# C #", + "#########" + ) + .bindFiller('#', Material.BLACK_STAINED_GLASS_PANE) + .bind('S', ItemBuilder.of(Material.EMERALD).name("Boutique").asGuiItem(this::ouvrirShop)) + .bind('K', ItemBuilder.of(Material.CHEST).name("Kits").asGuiItem(this::ouvrirKits)) + .bind('Q', ItemBuilder.of(Material.BOOK).name("QuĂȘtes").asGuiItem(this::ouvrirQuetes)) + .bind('C', ItemBuilder.of(Material.BARRIER).name("Fermer").asGuiItem(GuiClickContext::close)) + .build(); + +// Application directe sur le GUI +BetterMcGuis.builder("Menu Principal", 5) + .pattern(pattern) + .build() + .open(player); +``` + +Vous pouvez aussi dĂ©finir le motif directement dans le builder de maniĂšre fluide : + +```java +BetterMcGuis.builder("Menu Compact", 3) + .pattern(p -> p + .lines( + "111111111", + "1 D 1", + "111111111" + ) + .bindFiller('1', Material.GRAY_STAINED_GLASS_PANE) + .bind('D', ItemBuilder.of(Material.DIAMOND).name("TrĂ©sor").asGuiItem()) + ) + .build(); +``` + +--- + +## 3. Masques de SĂ©lection de Slots (`GuiMask`) + +Un `GuiMask` permet de sĂ©lectionner des ensembles de slots spĂ©cifiques via une matrice binaire (`0` et `1`) pour dĂ©finir par exemple des zones d'items paginĂ©s ou des slots Ă©ditables : + +```java +GuiMask masqueZone = new GuiMask( + "000000000", + "011111110", + "011111110", + "000000000" +); + +// Utilisation pour dĂ©finir les slots d'un menu paginĂ© +BetterMcGuis.paginated("Boutique", 4) + .itemSlots(masqueZone) + .build(); +``` + +--- + +> 📖 **Étape suivante** : DĂ©couvrez les menus avancĂ©s dans [05_PAGINATED_AND_ADVANCED_GUIS.md](05_PAGINATED_AND_ADVANCED_GUIS.md). diff --git a/docs/05_PAGINATED_AND_ADVANCED_GUIS.md b/docs/05_PAGINATED_AND_ADVANCED_GUIS.md new file mode 100644 index 0000000..7ef4c66 --- /dev/null +++ b/docs/05_PAGINATED_AND_ADVANCED_GUIS.md @@ -0,0 +1,89 @@ +# 📚 Menus PaginĂ©s, Onglets & Animations - betterMcGuis + +Ce guide explore les types d'inventaires avancĂ©s : **PaginatedGui**, **TabbedGui** et **AnimatedGui**. + +--- + +## 📑 Sommaire +- [1. Menus PaginĂ©s (`PaginatedGui`)](#1-menus-paginĂ©s-paginatedgui) +- [2. Menus Ă  Onglets (`TabbedGui`)](#2-menus-Ă -onglets-tabbedgui) +- [3. Menus AnimĂ©s (`AnimatedGui`)](#3-menus-animĂ©s-animatedgui) + +--- + +## 1. Menus PaginĂ©s (`PaginatedGui`) + +Le `PaginatedGui` prend en charge le calcul automatique des pages, la disposition des boutons de navigation et les indicateurs dynamiques. + +```java +var shop = BetterMcGuis.paginated("Boutique", 5) + .fillBorder(Material.BLACK_STAINED_GLASS_PANE) + // Personnalisation des boutons de navigation + .previousButton(38, ItemBuilder.of(Material.ARROW).name("◀ Page PrĂ©cĂ©dente").asGuiItem()) + .nextButton(42, ItemBuilder.of(Material.ARROW).name("Page Suivante ▶").asGuiItem()) + // Indicateur de page personnalisĂ©e + .pageIndicator(40, (page, total) -> ItemBuilder.of(Material.PAPER) + .name("Page " + page + " / " + total + "") + .asGuiItem() + ); + +// Ajout de 100 items au catalogue +for (int i = 1; i <= 100; i++) { + shop.addPageItem(ItemBuilder.of(Material.GOLD_INGOT) + .name("Lingot #" + i + "") + .asGuiItem(ctx -> ctx.replySuccess("Achat rĂ©ussi !")) + ); +} + +shop.build().open(player); +``` + +--- + +## 2. Menus Ă  Onglets (`TabbedGui`) + +Permet de basculer instantanĂ©ment entre plusieurs catĂ©gories d'items **sans fermer ni rouvrir l'inventaire** : + +```java +BetterMcGuis.tabbed("Menu Multi-CatĂ©gories", 4) + // Onglet 1 : Guerrier + .tab("warrior", 11, ItemBuilder.of(Material.IRON_SWORD).name("Guerrier").asGuiItem(), tabGui -> { + tabGui.setTabItem("warrior", 20, ItemBuilder.of(Material.DIAMOND_SWORD).name("ÉpĂ©e Lourde").asGuiItem()); + tabGui.setTabItem("warrior", 24, ItemBuilder.of(Material.SHIELD).name("Bouclier").asGuiItem()); + }) + + // Onglet 2 : Archer + .tab("archer", 15, ItemBuilder.of(Material.BOW).name("Archer").asGuiItem(), tabGui -> { + tabGui.setTabItem("archer", 22, ItemBuilder.of(Material.CROSSBOW).name("ArbalĂšte PrĂ©cise").asGuiItem()); + }) + + .build() + .open(player); +``` + +--- + +## 3. Menus AnimĂ©s (`AnimatedGui`) + +Permet d'animer des frames d'inventaires cadencĂ©es par tick ou secondes : + +```java +AnimatedGui animated = BetterMcGuis.animated() + .title("Ouverture de Coffre MystĂšre...") + .rows(3) + // Frame 1 + .frame(f -> f.item(13, ItemBuilder.of(Material.CHEST).name("Chargement.").asGuiItem())) + // Frame 2 + .frame(f -> f.item(13, ItemBuilder.of(Material.ENDER_CHEST).name("Chargement..").asGuiItem())) + // Frame 3 : RĂ©vĂ©lation du lot ! + .frame(f -> f.item(13, ItemBuilder.of(Material.NETHER_STAR).name("Bravo ! TrĂ©sor Obtenu !").asGuiItem())) + .loop(false) + .build(); + +animated.open(player); +animated.startAnimation(monPlugin, Duration.ofMillis(600)); +``` + +--- + +> 📖 **Étape suivante** : DĂ©couvrez le cycle de vie et les Ă©vĂ©nements dans [06_LIFECYCLE_AND_EVENTS.md](06_LIFECYCLE_AND_EVENTS.md). diff --git a/docs/06_LIFECYCLE_AND_EVENTS.md b/docs/06_LIFECYCLE_AND_EVENTS.md new file mode 100644 index 0000000..51a82ae --- /dev/null +++ b/docs/06_LIFECYCLE_AND_EVENTS.md @@ -0,0 +1,91 @@ +# 🎯 Cycle de Vie & SystĂšme d'ÉvĂ©nements - betterMcGuis + +La bibliothĂšque intĂšgre un moteur d'Ă©vĂ©nements Ă  deux niveaux : **Hooks Locaux** (sur l'instance du menu) et **Bus d'ÉvĂ©nements Global** (avec annotations `@GuiEventHandler`). + +--- + +## 📑 Sommaire +- [1. Hooks Locaux sur l'Instance de Menu](#1-hooks-locaux-sur-linstance-de-menu) +- [2. Bus d'ÉvĂ©nements Global & Annotations `@GuiEventHandler`](#2-bus-dĂ©vĂ©nements-global--annotations-guieventhandler) +- [3. RĂ©fĂ©rence Exhaustive des ÉvĂ©nements](#3-rĂ©fĂ©rence-exhaustive-des-Ă©vĂ©nements) + +--- + +## 1. Hooks Locaux sur l'Instance de Menu + +```java +BetterMcGuis.builder("Banque", 3) + .onOpen(ctx -> { + ctx.getPlayer().sendMessage("§aBienvenue dans votre coffre sĂ©curisĂ©."); + }) + .onClose(ctx -> { + sauvegarderDonnees(ctx.getPlayer()); + }) + .onOutsideClick(ctx -> { + // Ferme si le joueur clique en dehors du menu + ctx.close(); + }) + .onBottomClick(ctx -> { + // Clic dans son propre inventaire + ctx.getPlayer().sendMessage("§7Action dĂ©tectĂ©e dans votre inventaire."); + }) + .build(); +``` + +--- + +## 2. Bus d'ÉvĂ©nements Global & Annotations `@GuiEventHandler` + +Vous pouvez crĂ©er des classes dĂ©diĂ©es pour auditer, logger ou sĂ©curiser l'ensemble des GUIs de votre serveur : + +```java +package fr.luc.monplugin.listener; + +import fr.luc.bettermcguis.event.*; +import fr.luc.bettermcguis.event.annotation.GuiEventHandler; + +public class MonEcouteurGlobalGui { + + // Écoute TOUS les clics de GUIs avec prioritĂ© Ă©levĂ©e + @GuiEventHandler(priority = 100) + public void onGlobalClick(GuiClickEvent event) { + var ctx = event.getContext(); + System.out.println("[Audit GUI] Joueur : " + ctx.getPlayer().getName() + + " | Slot : #" + ctx.getSlot() + + " | Clic : " + ctx.getClickType()); + } + + // Écoute UNIQUEMENT les ouvertures de la boutique + @GuiEventHandler(guiTitle = "Boutique PaginĂ©e") + public void onShopOpen(GuiOpenEvent event) { + event.getPlayer().sendMessage("§eProfitez des promotions du week-end !"); + } + + // Écoute les fermetures de menus + @GuiEventHandler + public void onClose(GuiCloseEvent event) { + // Traitement global + } +} +``` + +Pour enregistrer l'Ă©couteur : +```java +guiManager.registerListeners(new MonEcouteurGlobalGui()); +``` + +--- + +## 3. RĂ©fĂ©rence Exhaustive des ÉvĂ©nements + +| Classe d'ÉvĂ©nement | Description | Annulable ? | +|---|---|:---:| +| `GuiOpenEvent` | DĂ©clenchĂ© avant l'ouverture du menu pour un joueur. | ✅ **Oui** | +| `GuiCloseEvent` | DĂ©clenchĂ© lorsque le joueur ferme le menu. | ❌ Non | +| `GuiClickEvent` | DĂ©clenchĂ© lors de chaque clic (item, slot vide ou extĂ©rieur). | ✅ **Oui** | +| `GuiPageChangeEvent` | DĂ©clenchĂ© lors d'un changement de page dans un `PaginatedGui`. | ❌ Non | +| `GuiRefreshEvent` | DĂ©clenchĂ© lors du rafraĂźchissement d'un inventaire. | ❌ Non | + +--- + +> 📖 **Étape suivante** : DĂ©couvrez les zones de stockage dans [07_STORAGE_AND_EDITABLE_SLOTS.md](07_STORAGE_AND_EDITABLE_SLOTS.md). diff --git a/docs/07_STORAGE_AND_EDITABLE_SLOTS.md b/docs/07_STORAGE_AND_EDITABLE_SLOTS.md new file mode 100644 index 0000000..5f2789f --- /dev/null +++ b/docs/07_STORAGE_AND_EDITABLE_SLOTS.md @@ -0,0 +1,59 @@ +# 📩 Zones de Stockage & Slots Éditables - betterMcGuis + +Par dĂ©faut, tous les menus crĂ©Ă©s avec `betterMcGuis` interdisent le vol, le dĂ©placement et le shift-clic d'items pour garantir une sĂ©curitĂ© totale contre les duplications de bugs d'inventaires. + +Cependant, pour les fonctionnalitĂ©s nĂ©cessitant que les joueurs dĂ©posent ou retirent des objets (comme une poubelle, un coffre de recyclage, une enclume ou un hĂŽtel des ventes), `betterMcGuis` propose **les slots Ă©ditables** et le **`StorageGui`**. + +--- + +## 📑 Sommaire +- [1. Slots Éditables dans un GUI Standard](#1-slots-Ă©ditables-dans-un-gui-standard) +- [2. Menu de Stockage DĂ©diĂ© (`StorageGui`)](#2-menu-de-stockage-dĂ©diĂ©-storagegui) +- [3. SĂ©curitĂ© contre les Duplications et Glitches](#3-sĂ©curitĂ©-contre-les-duplications-et-glitches) + +--- + +## 1. Slots Éditables dans un GUI Standard + +Vous pouvez autoriser les interactions de placement et retrait d'items sur des slots ciblĂ©s avec `.editable(...)` : + +```java +BetterMcGuis.builder("BoĂźte de DĂ©pĂŽt", 3) + .fillBorder(Material.BLACK_STAINED_GLASS_PANE) + // Rend le slot 13 (centre) modifiable librement par le joueur + .editable(13) + .build() + .open(player); +``` + +--- + +## 2. Menu de Stockage DĂ©diĂ© (`StorageGui`) + +`StorageGui` simplifie la gestion d'une zone centrale de dĂ©pĂŽt avec restitution automatique des items laissĂ©s Ă  la fermeture : + +```java +StorageGui trash = new StorageGui("Poubelle", GuiType.CHEST_4_ROWS); + +// Remplissage des bordures avec du vitrage +trash.fillBorder(ItemBuilder.filler(Material.RED_STAINED_GLASS_PANE).asGuiItem()); + +// DĂ©finit les slots intĂ©rieurs comme zone de dĂ©pĂŽt +trash.setStorageSlots(SlotRange.interior(4, 9)); + +// true = restitue les items au joueur Ă  la fermeture +// false = dĂ©truit dĂ©finitivement les items Ă  la fermeture (idĂ©al poubelle) +trash.returnItemsOnClose(false); + +trash.open(player); +``` + +--- + +## 3. SĂ©curitĂ© contre les Duplications et Glitches + +Le gestionnaire `BukkitGuiEventListener` applique des sĂ©curitĂ©s strictes : +* **Shift-Clic Protection** : EmpĂȘche un joueur de shift-cliquer un item depuis son inventaire vers un slot protĂ©gĂ© du menu. +* **Number Key Protection** : EmpĂȘche l'Ă©change d'items via les touches numĂ©riques (1 Ă  9 de la hotbar) vers des slots non Ă©ditables. +* **Drag-and-Drop Protection** : Bloque le glisser-dĂ©poser de curseur sur tous les slots non autorisĂ©s. +* **Nettoyage automatique** : En cas de dĂ©connexion ou de fermeture inopinĂ©e, les items des zones avec `returnItemsOnClose(true)` sont automatiquement rĂ©insĂ©rĂ©s dans l'inventaire du joueur ou dĂ©posĂ©s au sol s'il est plein. diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..93f0692 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,2 @@ +org.gradle.jvmargs=-Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8 +systemProp.file.encoding=UTF-8 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..f94fe18 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..249efbb --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..a51ec4f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..ad27875 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "betterMcGuis" diff --git a/src/main/java/fr/luc/bettermcguis/BetterMcGuis.java b/src/main/java/fr/luc/bettermcguis/BetterMcGuis.java new file mode 100644 index 0000000..c8e30b7 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/BetterMcGuis.java @@ -0,0 +1,167 @@ +package fr.luc.bettermcguis; + +import fr.luc.bettermcguis.builder.*; +import fr.luc.bettermcguis.event.GuiEventManager; +import fr.luc.bettermcguis.listener.BukkitGuiEventListener; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.event.HandlerList; +import org.bukkit.inventory.ItemStack; +import org.bukkit.plugin.Plugin; + +import java.util.Objects; + +/** + * Point d'entrĂ©e principal et gestionnaire central de la bibliothĂšque **betterMcGuis**. + * Fournit l'accĂšs aux constructeurs fluides de menus (simples, paginĂ©s, Ă  onglets, animĂ©s), + * au constructeur d'items (ItemBuilder), aux motifs ASCII et au bus d'Ă©vĂ©nements. + */ +public class BetterMcGuis { + + private static BetterMcGuis instance; + + private final Plugin plugin; + private final GuiEventManager eventManager; + private final BukkitGuiEventListener bukkitListener; + + /** + * Initialise une instance de betterMcGuis pour un plugin donnĂ©. + * + * @param plugin Le plugin Bukkit/Paper propriĂ©taire. + */ + public BetterMcGuis(Plugin plugin) { + this.plugin = plugin; + this.eventManager = new GuiEventManager(); + this.bukkitListener = new BukkitGuiEventListener(this); + + if (plugin != null) { + Bukkit.getPluginManager().registerEvents(bukkitListener, plugin); + } + + if (instance == null) { + instance = this; + } + } + + /** + * Initialise betterMcGuis pour un plugin Bukkit/Paper. + * + * @param plugin Le plugin propriĂ©taire. + * @return L'instance configurĂ©e. + */ + public static BetterMcGuis create(Plugin plugin) { + return new BetterMcGuis(plugin); + } + + /** + * @return L'instance globale ou par dĂ©faut. + */ + public static BetterMcGuis getInstance() { + return instance; + } + + /** + * CrĂ©e un nouveau constructeur de menu standard ({@link GuiBuilder}). + */ + public static GuiBuilder builder() { + return new GuiBuilder(); + } + + /** + * CrĂ©e un nouveau constructeur de menu avec titre et nombre de lignes. + */ + public static GuiBuilder builder(String title, int rows) { + return new GuiBuilder().title(title).rows(rows); + } + + /** + * CrĂ©e un nouveau constructeur d'inventaire paginĂ© ({@link PaginatedGuiBuilder}). + */ + public static PaginatedGuiBuilder paginated() { + return new PaginatedGuiBuilder(); + } + + /** + * CrĂ©e un nouveau constructeur d'inventaire paginĂ© avec titre et nombre de lignes. + */ + public static PaginatedGuiBuilder paginated(String title, int rows) { + return (PaginatedGuiBuilder) new PaginatedGuiBuilder().title(title).rows(rows); + } + + /** + * CrĂ©e un nouveau constructeur de menu Ă  onglets ({@link TabbedGuiBuilder}). + */ + public static TabbedGuiBuilder tabbed() { + return new TabbedGuiBuilder(); + } + + /** + * CrĂ©e un nouveau constructeur de menu Ă  onglets avec titre et nombre de lignes. + */ + public static TabbedGuiBuilder tabbed(String title, int rows) { + return (TabbedGuiBuilder) new TabbedGuiBuilder().title(title).rows(rows); + } + + /** + * CrĂ©e un nouveau constructeur de menu animĂ© ({@link AnimatedGuiBuilder}). + */ + public static AnimatedGuiBuilder animated() { + return new AnimatedGuiBuilder(); + } + + /** + * CrĂ©e un nouveau constructeur d'ItemStack moderne ({@link ItemBuilder}). + */ + public static ItemBuilder item(Material material) { + return ItemBuilder.of(material); + } + + /** + * CrĂ©e un constructeur d'item Ă  partir d'un {@link ItemStack} existant. + */ + public static ItemBuilder item(ItemStack itemStack) { + return ItemBuilder.of(itemStack); + } + + /** + * CrĂ©e un nouveau constructeur de motif / masque ASCII ({@link PatternBuilder}). + */ + public static PatternBuilder pattern(String... lines) { + return new PatternBuilder(lines); + } + + /** + * Enregistre un ou plusieurs Ă©couteurs d'Ă©vĂ©nements de GUI annotĂ©s avec {@link fr.luc.bettermcguis.event.annotation.GuiEventHandler}. + * + * @param listeners Les objets Ă©couteurs. + */ + public void registerListeners(Object... listeners) { + if (listeners != null) { + for (Object listener : listeners) { + eventManager.registerListeners(listener); + } + } + } + + /** + * @return Le gestionnaire de bus d'Ă©vĂ©nements central. + */ + public GuiEventManager getEventManager() { + return eventManager; + } + + /** + * @return Le plugin Bukkit associĂ©. + */ + public Plugin getPlugin() { + return plugin; + } + + /** + * DĂ©senregistre les Ă©couteurs Bukkit et nettoie toutes les ressources lors de la dĂ©sactivation du plugin. + */ + public void unregisterAll() { + HandlerList.unregisterAll(bukkitListener); + eventManager.clear(); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/animation/Frame.java b/src/main/java/fr/luc/bettermcguis/animation/Frame.java new file mode 100644 index 0000000..6a17425 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/animation/Frame.java @@ -0,0 +1,67 @@ +package fr.luc.bettermcguis.animation; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.pattern.GuiPattern; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +/** + * ReprĂ©sente une image / frame individuelle dans un GUI animĂ©. + */ +public class Frame { + + private final Map items = new HashMap<>(); + private String title; + + public Frame() {} + + public Frame(String title) { + this.title = title; + } + + /** + * DĂ©finit le titre de cette frame. + */ + public Frame title(String title) { + this.title = title; + return this; + } + + /** + * DĂ©finit un item dans cette frame. + */ + public Frame item(int slot, GuiItem item) { + this.items.put(slot, item); + return this; + } + + /** + * Applique un motif Ă  cette frame. + */ + public Frame pattern(GuiPattern pattern, int cols, int maxRows) { + if (pattern != null) { + var rows = pattern.getRows(); + var bindings = pattern.getItemBindings(); + for (int r = 0; r < Math.min(rows.size(), maxRows); r++) { + String line = rows.get(r); + for (int c = 0; c < Math.min(line.length(), cols); c++) { + char ch = line.charAt(c); + if (bindings.containsKey(ch)) { + items.put(r * cols + c, bindings.get(ch)); + } + } + } + } + return this; + } + + public Map getItems() { + return Collections.unmodifiableMap(items); + } + + public String getTitle() { + return title; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/Gui.java b/src/main/java/fr/luc/bettermcguis/api/Gui.java new file mode 100644 index 0000000..fb0b4b3 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/Gui.java @@ -0,0 +1,277 @@ +package fr.luc.bettermcguis.api; + +import fr.luc.bettermcguis.api.slot.SlotPos; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.pattern.GuiPattern; +import net.kyori.adventure.text.Component; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; + +import java.util.Map; +import java.util.Set; +import java.util.function.Consumer; + +/** + * Interface principale dĂ©finissant le comportement d'un menu d'inventaire interactif (GUI). + */ +public interface Gui { + + /** + * @return Le titre actuel du menu au format MiniMessage. + */ + String getTitle(); + + /** + * @return Le titre actuel sous forme de composant Adventure. + */ + Component getTitleComponent(); + + /** + * Modifie le titre du menu (met Ă  jour le titre pour les joueurs connectĂ©s si supportĂ©). + * + * @param miniMessage Le nouveau titre en MiniMessage. + */ + void setTitle(String miniMessage); + + /** + * @return Le type et la gĂ©omĂ©trie de cet inventaire. + */ + GuiType getType(); + + /** + * @return Le nombre total de slots de l'inventaire. + */ + default int getSize() { + return getType().getSize(); + } + + /** + * @return Le nombre de lignes de l'inventaire. + */ + default int getRows() { + return getType().getRows(); + } + + /** + * @return Le nombre de colonnes de l'inventaire (ex: 9 pour un coffre). + */ + default int getColumns() { + return getType().getColumns(); + } + + /** + * Place un item dans un slot absolu (0-indexĂ©). + * + * @param slot Le numĂ©ro de slot. + * @param item L'item Ă  placer. + */ + void setItem(int slot, GuiItem item); + + /** + * Place un item Ă  des coordonnĂ©es (ligne, colonne) en 0-indexĂ©. + * + * @param row La ligne (0 Ă  rows - 1). + * @param col La colonne (0 Ă  cols - 1). + * @param item L'item Ă  placer. + */ + default void setItem(int row, int col, GuiItem item) { + setItem(row * getColumns() + col, item); + } + + /** + * Place un item Ă  une position {@link SlotPos}. + * + * @param pos La position. + * @param item L'item. + */ + default void setItem(SlotPos pos, GuiItem item) { + if (pos != null) { + setItem(pos.toSlot(getColumns()), item); + } + } + + /** + * RĂ©cupĂšre le {@link GuiItem} prĂ©sent Ă  un slot donnĂ©. + * + * @param slot Le numĂ©ro de slot absolu. + * @return Le GuiItem, ou {@code null} si le slot est vide. + */ + GuiItem getItem(int slot); + + /** + * Supprime l'item prĂ©sent au slot donnĂ©. + * + * @param slot Le numĂ©ro de slot. + */ + void removeItem(int slot); + + /** + * Supprime tous les items de l'inventaire. + */ + void clear(); + + /** + * Remplit tous les slots vides ou existants avec un item donnĂ©. + * + * @param item L'item de remplissage. + */ + void fill(GuiItem item); + + /** + * Remplit uniquement les bordures extĂ©rieures de l'inventaire. + * + * @param item L'item de bordure. + */ + void fillBorder(GuiItem item); + + /** + * Remplit une plage de slots spĂ©cifique. + * + * @param range La plage de slots. + * @param item L'item. + */ + void fillRange(SlotRange range, GuiItem item); + + /** + * Applique un motif / masque ASCII sur l'inventaire. + * + * @param pattern Le motif Ă  appliquer. + */ + void applyPattern(GuiPattern pattern); + + /** + * Ouvre l'inventaire pour un joueur. + * + * @param player Le joueur. + */ + void open(Player player); + + /** + * Ferme l'inventaire pour un joueur. + * + * @param player Le joueur. + */ + void close(Player player); + + /** + * RafraĂźchit l'affichage de l'inventaire pour un joueur actuellement visualisateur. + * + * @param player Le joueur. + */ + void refresh(Player player); + + /** + * RafraĂźchit l'inventaire pour l'ensemble des joueurs visualisant actuellement ce GUI. + */ + void refreshAll(); + + /** + * @return L'ensemble des joueurs qui visualisent actuellement ce menu. + */ + Set getViewers(); + + /** + * CrĂ©e ou met Ă  jour l'inventaire Bukkit sous-jacent pour un joueur. + * + * @param player Le joueur pour lequel l'inventaire est gĂ©nĂ©rĂ©. + * @return L'instance {@link Inventory} Bukkit. + */ + Inventory createInventory(Player player); + + /** + * DĂ©finit si un slot donnĂ© est modifiable par le joueur (permet de dĂ©poser ou retirer des items). + * + * @param slot Le numĂ©ro de slot. + * @param editable true pour autoriser les interactions de dĂ©placement d'items. + */ + void setEditable(int slot, boolean editable); + + /** + * @param slot Le numĂ©ro de slot. + * @return true si le joueur a le droit de poser ou retirer des items dans ce slot. + */ + boolean isEditable(int slot); + + /** + * @return L'ensemble des slots Ă©ditables par les joueurs. + */ + Set getEditableSlots(); + + /** + * Stocke une propriĂ©tĂ© personnalisĂ©e dans le GUI. + * + * @param key La clĂ© identifiant la propriĂ©tĂ©. + * @param value La valeur. + */ + void setProperty(String key, Object value); + + /** + * RĂ©cupĂšre une propriĂ©tĂ© typĂ©e. + * + * @param key La clĂ©. + * @param type Le type attendu. + * @param Le type gĂ©nĂ©rique. + * @return La valeur, ou {@code null}. + */ + T getProperty(String key, Class type); + + /** + * RĂ©cupĂšre une propriĂ©tĂ© ou retourne une valeur par dĂ©faut. + */ + T getProperty(String key, T defaultValue); + + /** + * @return La table complĂšte des propriĂ©tĂ©s du GUI. + */ + Map getProperties(); + + /** + * Attache un Ă©couteur dĂ©clenchĂ© lors de l'ouverture du menu. + */ + Gui onOpen(Consumer hook); + + /** + * Attache un Ă©couteur dĂ©clenchĂ© lors de la fermeture du menu. + */ + Gui onClose(Consumer hook); + + /** + * Attache un Ă©couteur dĂ©clenchĂ© lors de n'importe quel clic dans l'inventaire supĂ©rieur. + */ + Gui onClick(Consumer hook); + + /** + * Attache un Ă©couteur dĂ©clenchĂ© lors d'un clic en dehors de l'inventaire (extĂ©rieur). + */ + Gui onOutsideClick(Consumer hook); + + /** + * Attache un Ă©couteur dĂ©clenchĂ© lors d'un clic dans l'inventaire du joueur (inventaire infĂ©rieur). + */ + Gui onBottomClick(Consumer hook); + + /** + * ExĂ©cute le hook d'ouverture. + */ + void handleOpen(GuiOpenContext context); + + /** + * ExĂ©cute le hook de fermeture. + */ + void handleClose(GuiCloseContext context); + + /** + * ExĂ©cute le hook de clic global. + */ + void handleClick(GuiClickContext context); + + /** + * ExĂ©cute le hook de clic extĂ©rieur. + */ + void handleOutsideClick(GuiClickContext context); + + /** + * ExĂ©cute le hook de clic dans l'inventaire infĂ©rieur. + */ + void handleBottomClick(GuiClickContext context); +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiClickAction.java b/src/main/java/fr/luc/bettermcguis/api/GuiClickAction.java new file mode 100644 index 0000000..1b36af1 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiClickAction.java @@ -0,0 +1,15 @@ +package fr.luc.bettermcguis.api; + +/** + * Interface fonctionnelle dĂ©clenchĂ©e lors d'un clic sur un item d'un GUI. + */ +@FunctionalInterface +public interface GuiClickAction { + + /** + * ExĂ©cute l'action associĂ©e au clic. + * + * @param context Le contexte complet du clic. + */ + void execute(GuiClickContext context); +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiClickContext.java b/src/main/java/fr/luc/bettermcguis/api/GuiClickContext.java new file mode 100644 index 0000000..a24ea75 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiClickContext.java @@ -0,0 +1,229 @@ +package fr.luc.bettermcguis.api; + +import fr.luc.bettermcguis.api.slot.SlotPos; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.minimessage.MiniMessage; +import org.bukkit.Sound; +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.ClickType; +import org.bukkit.event.inventory.InventoryAction; +import org.bukkit.event.inventory.InventoryClickEvent; +import org.bukkit.inventory.ItemStack; + +import java.util.Objects; + +/** + * Contexte transmis lors d'une interaction / clic sur un slot ou item d'un GUI. + */ +public class GuiClickContext { + + private final Player player; + private final Gui gui; + private final GuiItem guiItem; + private final int slot; + private final SlotPos slotPos; + private final ClickType clickType; + private final InventoryAction inventoryAction; + private final ItemStack currentItem; + private final ItemStack cursorItem; + private final InventoryClickEvent rawEvent; + private boolean cancelled = true; // Par dĂ©faut, les clics sont annulĂ©s pour Ă©viter le vol d'items + + /** + * CrĂ©e un nouveau contexte de clic. + */ + public GuiClickContext(Player player, Gui gui, GuiItem guiItem, int slot, SlotPos slotPos, + ClickType clickType, InventoryAction inventoryAction, + ItemStack currentItem, ItemStack cursorItem, InventoryClickEvent rawEvent) { + this.player = Objects.requireNonNull(player, "player cannot be null"); + this.gui = Objects.requireNonNull(gui, "gui cannot be null"); + this.guiItem = guiItem; + this.slot = slot; + this.slotPos = slotPos; + this.clickType = clickType; + this.inventoryAction = inventoryAction; + this.currentItem = currentItem; + this.cursorItem = cursorItem; + this.rawEvent = rawEvent; + } + + /** + * @return Le joueur ayant effectuĂ© le clic. + */ + public Player getPlayer() { + return player; + } + + /** + * @return Le GUI dans lequel le clic a eu lieu. + */ + public Gui getGui() { + return gui; + } + + /** + * @return L'item {@link GuiItem} cliquĂ©, ou {@code null} si slot vide. + */ + public GuiItem getGuiItem() { + return guiItem; + } + + /** + * @return Le numĂ©ro de slot absolu (0-indexĂ©). + */ + public int getSlot() { + return slot; + } + + /** + * @return La position (ligne, colonne) du slot cliquĂ©. + */ + public SlotPos getSlotPos() { + return slotPos; + } + + /** + * @return Le type de clic (ex: LEFT, RIGHT, SHIFT_LEFT, MIDDLE, NUMBER_KEY). + */ + public ClickType getClickType() { + return clickType; + } + + /** + * @return L'action d'inventaire Bukkit (ex: PICKUP_ALL, PLACE_ALL). + */ + public InventoryAction getInventoryAction() { + return inventoryAction; + } + + /** + * @return L'ItemStack actuellement prĂ©sent dans le slot cliquĂ©. + */ + public ItemStack getCurrentItem() { + return currentItem; + } + + /** + * @return L'ItemStack actuellement tenu sur le curseur de la souris. + */ + public ItemStack getCursorItem() { + return cursorItem; + } + + /** + * @return L'Ă©vĂ©nement Bukkit natif {@link InventoryClickEvent}, ou {@code null} lors de tests unitaires. + */ + public InventoryClickEvent getRawEvent() { + return rawEvent; + } + + /** + * @return true si le clic est annulĂ© (empĂȘche la prise ou le dĂ©placement d'items). + */ + public boolean isCancelled() { + return cancelled; + } + + /** + * DĂ©finit si le clic doit ĂȘtre annulĂ©. + * + * @param cancelled true pour bloquer l'action Bukkit native, false pour autoriser la modification du slot. + */ + public void setCancelled(boolean cancelled) { + this.cancelled = cancelled; + if (rawEvent != null) { + rawEvent.setCancelled(cancelled); + } + } + + /** + * @return true s'il s'agit d'un clic gauche (simple ou avec Shift). + */ + public boolean isLeftClick() { + return clickType == ClickType.LEFT || clickType == ClickType.SHIFT_LEFT; + } + + /** + * @return true s'il s'agit d'un clic droit (simple ou avec Shift). + */ + public boolean isRightClick() { + return clickType == ClickType.RIGHT || clickType == ClickType.SHIFT_RIGHT; + } + + /** + * @return true s'il s'agit d'un shift-clic. + */ + public boolean isShiftClick() { + return clickType == ClickType.SHIFT_LEFT || clickType == ClickType.SHIFT_RIGHT; + } + + /** + * Ferme l'inventaire actuel pour le joueur. + */ + public void close() { + player.closeInventory(); + } + + /** + * RafraĂźchit l'affichage du GUI pour le joueur. + */ + public void refresh() { + gui.refresh(player); + } + + /** + * Joue un son au joueur. + * + * @param sound Le son Bukkit. + * @param volume Le volume. + * @param pitch La hauteur de ton. + */ + public void playSound(Sound sound, float volume, float pitch) { + if (player != null && sound != null) { + player.playSound(player.getLocation(), sound, volume, pitch); + } + } + + /** + * Envoie un message formatĂ© avec MiniMessage au joueur. + * + * @param miniMessage Le texte au format MiniMessage. + */ + public void reply(String miniMessage) { + if (player != null && miniMessage != null) { + player.sendMessage(MiniMessage.miniMessage().deserialize(miniMessage)); + } + } + + /** + * Envoie un message de succĂšs prĂ©fixĂ© en vert. + */ + public void replySuccess(String miniMessage) { + reply("✔ " + (miniMessage != null ? miniMessage : "")); + } + + /** + * Envoie un message d'erreur prĂ©fixĂ© en rouge. + */ + public void replyError(String miniMessage) { + reply("✖ " + (miniMessage != null ? miniMessage : "")); + } + + /** + * Envoie un message d'information prĂ©fixĂ© en bleu clair. + */ + public void replyInfo(String miniMessage) { + reply("â„č " + (miniMessage != null ? miniMessage : "")); + } + + /** + * Envoie un composant Kyori Adventure au joueur. + * + * @param component Le composant texte. + */ + public void reply(Component component) { + if (player != null && component != null) { + player.sendMessage(component); + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiCloseContext.java b/src/main/java/fr/luc/bettermcguis/api/GuiCloseContext.java new file mode 100644 index 0000000..23641dd --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiCloseContext.java @@ -0,0 +1,34 @@ +package fr.luc.bettermcguis.api; + +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.InventoryCloseEvent; + +import java.util.Objects; + +/** + * Contexte transmis lors de la fermeture d'un GUI par un joueur. + */ +public class GuiCloseContext { + + private final Player player; + private final Gui gui; + private final InventoryCloseEvent rawEvent; + + public GuiCloseContext(Player player, Gui gui, InventoryCloseEvent rawEvent) { + this.player = Objects.requireNonNull(player, "player cannot be null"); + this.gui = Objects.requireNonNull(gui, "gui cannot be null"); + this.rawEvent = rawEvent; + } + + public Player getPlayer() { + return player; + } + + public Gui getGui() { + return gui; + } + + public InventoryCloseEvent getRawEvent() { + return rawEvent; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiItem.java b/src/main/java/fr/luc/bettermcguis/api/GuiItem.java new file mode 100644 index 0000000..fbdb450 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiItem.java @@ -0,0 +1,228 @@ +package fr.luc.bettermcguis.api; + +import org.bukkit.Material; +import org.bukkit.Sound; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; + +import java.time.Duration; +import java.time.Instant; +import java.util.Map; +import java.util.Objects; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Predicate; + +/** + * ReprĂ©sente un item interactif ou dĂ©coratif placĂ© dans un slot de GUI. + * Encapsule un {@link ItemStack}, des Ă©couteurs de clics, des sons, des conditions de visibilitĂ© et des cooldowns. + */ +public class GuiItem { + + private final ItemStack itemStack; + private GuiClickAction clickAction; + private Predicate visibilityCondition; + private boolean closeOnClick = false; + private boolean cancelClick = true; + private Sound clickSound; + private float soundVolume = 1.0f; + private float soundPitch = 1.0f; + private Duration clickCooldown = Duration.ZERO; + private final Map cooldowns = new ConcurrentHashMap<>(); + + /** + * CrĂ©e un GuiItem Ă  partir d'un {@link ItemStack}. + * + * @param itemStack L'item Minecraft sous-jacent. + */ + public GuiItem(ItemStack itemStack) { + this.itemStack = itemStack != null ? itemStack.clone() : new ItemStack(Material.AIR); + } + + /** + * CrĂ©e un GuiItem avec une action de clic associĂ©e. + * + * @param itemStack L'item sous-jacent. + * @param clickAction L'action exĂ©cutĂ©e lors du clic. + */ + public GuiItem(ItemStack itemStack, GuiClickAction clickAction) { + this(itemStack); + this.clickAction = clickAction; + } + + /** + * Fabrique statique Ă  partir d'un {@link ItemStack}. + */ + public static GuiItem of(ItemStack itemStack) { + return new GuiItem(itemStack); + } + + /** + * Fabrique statique avec action de clic. + */ + public static GuiItem of(ItemStack itemStack, GuiClickAction clickAction) { + return new GuiItem(itemStack, clickAction); + } + + /** + * Fabrique statique Ă  partir d'un matĂ©riau simple. + */ + public static GuiItem of(Material material) { + return new GuiItem(new ItemStack(material)); + } + + /** + * Fabrique statique pour un item dĂ©coratif de remplissage. + */ + public static GuiItem filler(Material material) { + ItemStack item = new ItemStack(material); + ItemMeta meta = item.getItemMeta(); + if (meta != null) { + meta.setDisplayName(" "); + item.setItemMeta(meta); + } + return new GuiItem(item); + } + + /** + * Fabrique statique pour un item vide (AIR). + */ + public static GuiItem empty() { + return new GuiItem(new ItemStack(Material.AIR)); + } + + /** + * DĂ©finit l'action de clic pour cet item. + * + * @param clickAction L'action de clic. + * @return Cette instance de {@link GuiItem} pour chaĂźnage. + */ + public GuiItem onClick(GuiClickAction clickAction) { + this.clickAction = clickAction; + return this; + } + + /** + * Conditionne la visibilitĂ© de cet item selon le joueur visualisant l'inventaire. + * + * @param condition Le prĂ©dicat testant le joueur. + * @return Cette instance. + */ + public GuiItem visibleIf(Predicate condition) { + this.visibilityCondition = condition; + return this; + } + + /** + * Ferme l'inventaire automatiquement dĂšs que le joueur clique sur cet item. + * + * @return Cette instance. + */ + public GuiItem closeOnClick() { + this.closeOnClick = true; + return this; + } + + /** + * Joue un son au joueur lors du clic. + * + * @param sound Le son Bukkit. + * @param volume Le volume. + * @param pitch La tonalitĂ©. + * @return Cette instance. + */ + public GuiItem sound(Sound sound, float volume, float pitch) { + this.clickSound = sound; + this.soundVolume = volume; + this.soundPitch = pitch; + return this; + } + + /** + * Joue un son avec volume et pitch par dĂ©faut (1.0f). + */ + public GuiItem sound(Sound sound) { + return sound(sound, 1.0f, 1.0f); + } + + /** + * DĂ©finit un cooldown entre chaque clic pour un joueur. + * + * @param cooldown La durĂ©e de cooldown. + * @return Cette instance. + */ + public GuiItem cooldown(Duration cooldown) { + this.clickCooldown = cooldown != null ? cooldown : Duration.ZERO; + return this; + } + + /** + * Indique si l'Ă©vĂ©nement Bukkit de clic doit ĂȘtre annulĂ© (empĂȘche de prendre l'item). + * + * @param cancel true pour annuler (comportement par dĂ©faut). + * @return Cette instance. + */ + public GuiItem cancelClick(boolean cancel) { + this.cancelClick = cancel; + return this; + } + + /** + * GĂšre le dĂ©clenchement de l'action de clic pour un contexte donnĂ©. + * + * @param context Le contexte de clic. + */ + public void handleClick(GuiClickContext context) { + if (cancelClick) { + context.setCancelled(true); + } + + Player player = context.getPlayer(); + if (player != null && !clickCooldown.isZero()) { + Instant now = Instant.now(); + Instant expire = cooldowns.get(player.getUniqueId()); + if (expire != null && now.isBefore(expire)) { + // Cooldown actif + return; + } + cooldowns.put(player.getUniqueId(), now.plus(clickCooldown)); + } + + if (clickSound != null && player != null) { + player.playSound(player.getLocation(), clickSound, soundVolume, soundPitch); + } + + if (clickAction != null) { + clickAction.execute(context); + } + + if (closeOnClick && player != null) { + context.close(); + } + } + + /** + * @return L'{@link ItemStack} sous-jacent. + */ + public ItemStack getItemStack() { + return itemStack; + } + + /** + * @return true si l'item est visible pour le joueur donnĂ©. + */ + public boolean isVisibleFor(Player player) { + if (visibilityCondition == null) { + return true; + } + return visibilityCondition.test(player); + } + + /** + * @return L'action de clic attachĂ©e. + */ + public GuiClickAction getClickAction() { + return clickAction; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiOpenContext.java b/src/main/java/fr/luc/bettermcguis/api/GuiOpenContext.java new file mode 100644 index 0000000..eda5fcf --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiOpenContext.java @@ -0,0 +1,46 @@ +package fr.luc.bettermcguis.api; + +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.InventoryOpenEvent; + +import java.util.Objects; + +/** + * Contexte transmis lors de l'ouverture d'un GUI. + */ +public class GuiOpenContext { + + private final Player player; + private final Gui gui; + private final InventoryOpenEvent rawEvent; + private boolean cancelled = false; + + public GuiOpenContext(Player player, Gui gui, InventoryOpenEvent rawEvent) { + this.player = Objects.requireNonNull(player, "player cannot be null"); + this.gui = Objects.requireNonNull(gui, "gui cannot be null"); + this.rawEvent = rawEvent; + } + + public Player getPlayer() { + return player; + } + + public Gui getGui() { + return gui; + } + + public InventoryOpenEvent getRawEvent() { + return rawEvent; + } + + public boolean isCancelled() { + return cancelled; + } + + public void setCancelled(boolean cancelled) { + this.cancelled = cancelled; + if (rawEvent != null) { + rawEvent.setCancelled(cancelled); + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/GuiType.java b/src/main/java/fr/luc/bettermcguis/api/GuiType.java new file mode 100644 index 0000000..79b6270 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/GuiType.java @@ -0,0 +1,81 @@ +package fr.luc.bettermcguis.api; + +import org.bukkit.event.inventory.InventoryType; + +import java.util.Objects; + +/** + * DĂ©finit le type et la taille d'un inventaire GUI (Coffre 1 Ă  6 lignes, Hopper, Distributeur, etc.). + */ +public enum GuiType { + + CHEST_1_ROW(9, InventoryType.CHEST, 1), + CHEST_2_ROWS(18, InventoryType.CHEST, 2), + CHEST_3_ROWS(27, InventoryType.CHEST, 3), + CHEST_4_ROWS(36, InventoryType.CHEST, 4), + CHEST_5_ROWS(45, InventoryType.CHEST, 5), + CHEST_6_ROWS(54, InventoryType.CHEST, 6), + HOPPER(5, InventoryType.HOPPER, 1), + DISPENSER(9, InventoryType.DISPENSER, 3), + DROPPER(9, InventoryType.DROPPER, 3), + ANVIL(3, InventoryType.ANVIL, 1), + WORKBENCH(10, InventoryType.WORKBENCH, 3), + BREWING(5, InventoryType.BREWING, 1); + + private final int size; + private final InventoryType bukkitType; + private final int rows; + + GuiType(int size, InventoryType bukkitType, int rows) { + this.size = size; + this.bukkitType = bukkitType; + this.rows = rows; + } + + /** + * @return Le nombre total de slots de l'inventaire. + */ + public int getSize() { + return size; + } + + /** + * @return Le type d'inventaire Bukkit correspondant. + */ + public InventoryType getBukkitType() { + return bukkitType; + } + + /** + * @return Le nombre de lignes de l'inventaire. + */ + public int getRows() { + return rows; + } + + /** + * @return Le nombre de colonnes de l'inventaire (9 pour un coffre, 5 pour hopper, 3 pour dispenser). + */ + public int getColumns() { + return size / rows; + } + + /** + * Retourne le type de coffre correspondant au nombre de lignes demandĂ© (1 Ă  6). + * + * @param rows Le nombre de lignes (1 Ă  6). + * @return Le type {@link GuiType}. + * @throws IllegalArgumentException si rows n'est pas compris entre 1 et 6. + */ + public static GuiType chest(int rows) { + return switch (rows) { + case 1 -> CHEST_1_ROW; + case 2 -> CHEST_2_ROWS; + case 3 -> CHEST_3_ROWS; + case 4 -> CHEST_4_ROWS; + case 5 -> CHEST_5_ROWS; + case 6 -> CHEST_6_ROWS; + default -> throw new IllegalArgumentException("Nombre de lignes de coffre invalide : " + rows + " (attendu: 1-6)"); + }; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/slot/SlotPos.java b/src/main/java/fr/luc/bettermcguis/api/slot/SlotPos.java new file mode 100644 index 0000000..d3c807b --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/slot/SlotPos.java @@ -0,0 +1,92 @@ +package fr.luc.bettermcguis.api.slot; + +import java.util.Objects; + +/** + * ReprĂ©sente la position d'un slot dans un inventaire GUI sous forme de coordonnĂ©es (ligne, colonne) en index 0. + */ +public class SlotPos { + + private final int row; + private final int column; + + /** + * CrĂ©e une position de slot Ă  partir d'une ligne et d'une colonne (0-indexĂ©s). + * + * @param row La ligne (0 Ă  rows - 1). + * @param column La colonne (0 Ă  cols - 1). + */ + public SlotPos(int row, int column) { + if (row < 0 || column < 0) { + throw new IllegalArgumentException("Les coordonnĂ©es de slot ne peuvent pas ĂȘtre nĂ©gatives : (" + row + ", " + column + ")"); + } + this.row = row; + this.column = column; + } + + /** + * CrĂ©e une instance de {@link SlotPos}. + * + * @param row La ligne (0-indexĂ©e). + * @param column La colonne (0-indexĂ©e). + * @return La position correspondante. + */ + public static SlotPos of(int row, int column) { + return new SlotPos(row, column); + } + + /** + * Calcule la position (ligne, colonne) Ă  partir d'un slot brut absolu et du nombre de colonnes par ligne. + * + * @param slot L'index brut du slot (0-indexĂ©). + * @param columns Le nombre de colonnes (ex: 9 pour un coffre). + * @return La position {@link SlotPos}. + */ + public static SlotPos fromSlot(int slot, int columns) { + if (slot < 0 || columns <= 0) { + throw new IllegalArgumentException("Slot ou nombre de colonnes invalide : slot=" + slot + ", cols=" + columns); + } + return new SlotPos(slot / columns, slot % columns); + } + + /** + * @return L'index de ligne (0-indexĂ©). + */ + public int getRow() { + return row; + } + + /** + * @return L'index de colonne (0-indexĂ©). + */ + public int getColumn() { + return column; + } + + /** + * Convertit cette position (ligne, colonne) en index de slot absolu (0-indexĂ©). + * + * @param columns Le nombre de colonnes de l'inventaire (ex: 9 pour un coffre). + * @return Le numĂ©ro de slot absolu. + */ + public int toSlot(int columns) { + return (row * columns) + column; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof SlotPos slotPos)) return false; + return row == slotPos.row && column == slotPos.column; + } + + @Override + public int hashCode() { + return Objects.hash(row, column); + } + + @Override + public String toString() { + return "SlotPos(row=" + row + ", col=" + column + ")"; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/api/slot/SlotRange.java b/src/main/java/fr/luc/bettermcguis/api/slot/SlotRange.java new file mode 100644 index 0000000..d1e52c3 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/api/slot/SlotRange.java @@ -0,0 +1,97 @@ +package fr.luc.bettermcguis.api.slot; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.stream.IntStream; + +/** + * ReprĂ©sente un ensemble ou une plage de slots dans un inventaire GUI. + */ +public class SlotRange { + + private final List slots; + + /** + * CrĂ©e une plage avec une liste de slots. + * + * @param slots Les numĂ©ros de slots. + */ + public SlotRange(List slots) { + this.slots = new ArrayList<>(slots); + } + + /** + * CrĂ©e une plage continue de slots entre {@code from} et {@code to} inclus. + * + * @param from Slot de dĂ©but (inclus). + * @param to Slot de fin (inclus). + * @return La plage correspondante. + */ + public static SlotRange of(int from, int to) { + List list = new ArrayList<>(); + int start = Math.min(from, to); + int end = Math.max(from, to); + for (int i = start; i <= end; i++) { + list.add(i); + } + return new SlotRange(list); + } + + /** + * CrĂ©e une plage Ă  partir d'une liste explicite de slots. + * + * @param slots Les slots. + * @return La plage correspondante. + */ + public static SlotRange ofSlots(int... slots) { + List list = new ArrayList<>(); + for (int s : slots) { + list.add(s); + } + return new SlotRange(list); + } + + /** + * CrĂ©e une plage correspondant aux bordures extĂ©rieures d'un inventaire. + * + * @param rows Le nombre de lignes. + * @param cols Le nombre de colonnes (ex: 9). + * @return La plage des slots de bordure. + */ + public static SlotRange border(int rows, int cols) { + List list = new ArrayList<>(); + for (int r = 0; r < rows; r++) { + for (int c = 0; c < cols; c++) { + if (r == 0 || r == rows - 1 || c == 0 || c == cols - 1) { + list.add(r * cols + c); + } + } + } + return new SlotRange(list); + } + + /** + * CrĂ©e une plage correspondant Ă  l'intĂ©rieur (sans les bordures) d'un inventaire. + * + * @param rows Le nombre de lignes. + * @param cols Le nombre de colonnes. + * @return La plage des slots intĂ©rieurs. + */ + public static SlotRange interior(int rows, int cols) { + List list = new ArrayList<>(); + for (int r = 1; r < rows - 1; r++) { + for (int c = 1; c < cols - 1; c++) { + list.add(r * cols + c); + } + } + return new SlotRange(list); + } + + /** + * @return La liste non modifiable des slots de cette plage. + */ + public List getSlots() { + return Collections.unmodifiableList(slots); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/AnimatedGuiBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/AnimatedGuiBuilder.java new file mode 100644 index 0000000..fa98b28 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/AnimatedGuiBuilder.java @@ -0,0 +1,96 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.animation.Frame; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.type.AnimatedGui; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.Consumer; + +/** + * Constructeur fluide pour concevoir des inventaires animĂ©s ({@link AnimatedGui}). + */ +public class AnimatedGuiBuilder extends GuiBuilder { + + private final List frames = new ArrayList<>(); + private boolean loop = true; + + public AnimatedGuiBuilder() {} + + @Override + public AnimatedGuiBuilder title(String miniMessage) { + super.title(miniMessage); + return this; + } + + @Override + public AnimatedGuiBuilder type(GuiType type) { + super.type(type); + return this; + } + + @Override + public AnimatedGuiBuilder rows(int rows) { + super.rows(rows); + return this; + } + + /** + * Ajoute une frame Ă  l'animation. + */ + public AnimatedGuiBuilder frame(Frame frame) { + this.frames.add(frame); + return this; + } + + /** + * Ajoute une frame configurĂ©e via une fonction lambda. + */ + public AnimatedGuiBuilder frame(Consumer frameConfig) { + Frame f = new Frame(); + if (frameConfig != null) { + frameConfig.accept(f); + } + return frame(f); + } + + /** + * Active ou dĂ©sactive la lecture en boucle. + */ + public AnimatedGuiBuilder loop(boolean loop) { + this.loop = loop; + return this; + } + + @Override + public AnimatedGui build() { + AnimatedGui gui = new AnimatedGui(title, type); + + for (var entry : items.entrySet()) { + gui.setItem(entry.getKey(), entry.getValue()); + } + for (var pattern : patterns) { + gui.applyPattern(pattern); + } + for (int s : editableSlots) { + gui.setEditable(s, true); + } + for (var entry : properties.entrySet()) { + gui.setProperty(entry.getKey(), entry.getValue()); + } + + for (var hook : openHooks) gui.onOpen(hook); + for (var hook : closeHooks) gui.onClose(hook); + for (var hook : clickHooks) gui.onClick(hook); + for (var hook : outsideClickHooks) gui.onOutsideClick(hook); + for (var hook : bottomClickHooks) gui.onBottomClick(hook); + + for (Frame frame : frames) { + gui.addFrame(frame); + } + gui.loop(loop); + + return gui; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/GuiBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/GuiBuilder.java new file mode 100644 index 0000000..7ff6225 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/GuiBuilder.java @@ -0,0 +1,238 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.api.*; +import fr.luc.bettermcguis.api.slot.SlotPos; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.pattern.GuiPattern; +import fr.luc.bettermcguis.type.SimpleGui; +import net.kyori.adventure.text.Component; +import org.bukkit.Material; +import org.bukkit.inventory.ItemStack; + +import java.util.*; +import java.util.function.Consumer; + +/** + * Constructeur fluide pour concevoir des menus d'inventaires interactifs standards ({@link SimpleGui}). + */ +public class GuiBuilder { + + protected String title = "Menu"; + protected GuiType type = GuiType.CHEST_3_ROWS; + protected final Map items = new HashMap<>(); + protected final Set editableSlots = new HashSet<>(); + protected final Map properties = new HashMap<>(); + protected final List patterns = new ArrayList<>(); + + protected final List> openHooks = new ArrayList<>(); + protected final List> closeHooks = new ArrayList<>(); + protected final List> clickHooks = new ArrayList<>(); + protected final List> outsideClickHooks = new ArrayList<>(); + protected final List> bottomClickHooks = new ArrayList<>(); + + public GuiBuilder() {} + + /** + * DĂ©finit le titre du GUI au format MiniMessage. + */ + public GuiBuilder title(String miniMessage) { + this.title = miniMessage; + return this; + } + + /** + * DĂ©finit le type et les dimensions du GUI. + */ + public GuiBuilder type(GuiType type) { + this.type = Objects.requireNonNull(type, "type cannot be null"); + return this; + } + + /** + * DĂ©finit un inventaire de type coffre avec le nombre de lignes spĂ©cifiĂ© (1 Ă  6). + */ + public GuiBuilder rows(int rows) { + this.type = GuiType.chest(rows); + return this; + } + + /** + * Place un {@link GuiItem} dans un slot absolu (0-indexĂ©). + */ + public GuiBuilder item(int slot, GuiItem item) { + this.items.put(slot, item); + return this; + } + + /** + * Place un {@link ItemStack} dans un slot avec une action optionnelle. + */ + public GuiBuilder item(int slot, ItemStack item, GuiClickAction action) { + return item(slot, GuiItem.of(item, action)); + } + + /** + * Place un item Ă  des coordonnĂ©es (ligne, colonne) en 0-indexĂ©. + */ + public GuiBuilder item(int row, int col, GuiItem item) { + return item(row * type.getColumns() + col, item); + } + + /** + * Place un item Ă  une position {@link SlotPos}. + */ + public GuiBuilder item(SlotPos pos, GuiItem item) { + if (pos != null) { + item(pos.toSlot(type.getColumns()), item); + } + return this; + } + + /** + * Remplit les bordures extĂ©rieures avec un item. + */ + public GuiBuilder fillBorder(GuiItem item) { + for (int slot : SlotRange.border(type.getRows(), type.getColumns()).getSlots()) { + this.items.put(slot, item); + } + return this; + } + + /** + * Remplit les bordures extĂ©rieures avec un matĂ©riau de vitrage. + */ + public GuiBuilder fillBorder(Material material) { + return fillBorder(GuiItem.filler(material)); + } + + /** + * Remplit une plage de slots. + */ + public GuiBuilder fillRange(SlotRange range, GuiItem item) { + if (range != null) { + for (int slot : range.getSlots()) { + this.items.put(slot, item); + } + } + return this; + } + + /** + * Applique un motif / masque ASCII {@link GuiPattern}. + */ + public GuiBuilder pattern(GuiPattern pattern) { + if (pattern != null) { + this.patterns.add(pattern); + } + return this; + } + + /** + * Construit et applique un motif via une fonction de configuration de {@link PatternBuilder}. + */ + public GuiBuilder pattern(Consumer patternConfig) { + if (patternConfig != null) { + PatternBuilder builder = new PatternBuilder(); + patternConfig.accept(builder); + pattern(builder.build()); + } + return this; + } + + /** + * Marque un ou plusieurs slots comme Ă©ditables par les joueurs. + */ + public GuiBuilder editable(int... slots) { + for (int s : slots) { + this.editableSlots.add(s); + } + return this; + } + + /** + * Marque une plage de slots comme Ă©ditables. + */ + public GuiBuilder editable(SlotRange range) { + if (range != null) { + this.editableSlots.addAll(range.getSlots()); + } + return this; + } + + /** + * DĂ©finit une propriĂ©tĂ© personnalisĂ©e. + */ + public GuiBuilder property(String key, Object value) { + this.properties.put(key, value); + return this; + } + + /** + * Hook exĂ©cutĂ© Ă  l'ouverture du GUI. + */ + public GuiBuilder onOpen(Consumer hook) { + this.openHooks.add(hook); + return this; + } + + /** + * Hook exĂ©cutĂ© Ă  la fermeture du GUI. + */ + public GuiBuilder onClose(Consumer hook) { + this.closeHooks.add(hook); + return this; + } + + /** + * Hook exĂ©cutĂ© lors d'un clic dans le GUI. + */ + public GuiBuilder onClick(Consumer hook) { + this.clickHooks.add(hook); + return this; + } + + /** + * Hook exĂ©cutĂ© lors d'un clic extĂ©rieur. + */ + public GuiBuilder onOutsideClick(Consumer hook) { + this.outsideClickHooks.add(hook); + return this; + } + + /** + * Hook exĂ©cutĂ© lors d'un clic dans l'inventaire du joueur. + */ + public GuiBuilder onBottomClick(Consumer hook) { + this.bottomClickHooks.add(hook); + return this; + } + + /** + * Construit l'instance finale de {@link SimpleGui}. + * + * @return L'instance configurĂ©e de {@link SimpleGui}. + */ + public SimpleGui build() { + SimpleGui gui = new SimpleGui(title, type); + for (Map.Entry entry : items.entrySet()) { + gui.setItem(entry.getKey(), entry.getValue()); + } + for (GuiPattern pattern : patterns) { + gui.applyPattern(pattern); + } + for (int s : editableSlots) { + gui.setEditable(s, true); + } + for (Map.Entry entry : properties.entrySet()) { + gui.setProperty(entry.getKey(), entry.getValue()); + } + + for (var hook : openHooks) gui.onOpen(hook); + for (var hook : closeHooks) gui.onClose(hook); + for (var hook : clickHooks) gui.onClick(hook); + for (var hook : outsideClickHooks) gui.onOutsideClick(hook); + for (var hook : bottomClickHooks) gui.onBottomClick(hook); + + return gui; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/ItemBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/ItemBuilder.java new file mode 100644 index 0000000..92e94ca --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/ItemBuilder.java @@ -0,0 +1,369 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.api.GuiClickAction; +import fr.luc.bettermcguis.api.GuiItem; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.minimessage.MiniMessage; +import org.bukkit.Bukkit; +import org.bukkit.Color; +import org.bukkit.Material; +import org.bukkit.NamespacedKey; +import org.bukkit.enchantments.Enchantment; +import org.bukkit.inventory.ItemFlag; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.inventory.meta.LeatherArmorMeta; +import org.bukkit.inventory.meta.PotionMeta; +import org.bukkit.inventory.meta.SkullMeta; +import org.bukkit.persistence.PersistentDataType; +import org.bukkit.potion.PotionType; + +import java.util.*; +import java.util.stream.Collectors; + +/** + * Constructeur moderne et fluide d'{@link ItemStack} supportant Kyori Adventure, MiniMessage, + * tĂȘtes personnalisĂ©es, armures teintĂ©es, flags et PersistentDataContainer. + */ +public class ItemBuilder { + + private final ItemStack itemStack; + private final ItemMeta meta; + + /** + * Initialise le builder avec un matĂ©riau de base. + * + * @param material Le matĂ©riau Bukkit. + */ + public ItemBuilder(Material material) { + this(new ItemStack(Objects.requireNonNull(material, "material cannot be null"))); + } + + /** + * Initialise le builder Ă  partir d'un {@link ItemStack} existant. + * + * @param itemStack L'item Ă  cloner et modifier. + */ + public ItemBuilder(ItemStack itemStack) { + Objects.requireNonNull(itemStack, "itemStack cannot be null"); + this.itemStack = itemStack.clone(); + this.meta = this.itemStack.getItemMeta(); + } + + /** + * Fabrique statique pour un matĂ©riau donnĂ©. + */ + public static ItemBuilder of(Material material) { + return new ItemBuilder(material); + } + + /** + * Fabrique statique pour un {@link ItemStack}. + */ + public static ItemBuilder of(ItemStack itemStack) { + return new ItemBuilder(itemStack); + } + + /** + * Fabrique statique pour une tĂȘte de joueur (PLAYER_HEAD). + */ + public static ItemBuilder skull() { + return new ItemBuilder(Material.PLAYER_HEAD); + } + + /** + * Fabrique statique pour un item dĂ©coratif de vitrage ou panneau. + */ + public static ItemBuilder filler(Material material) { + return of(material).name(" "); + } + + /** + * DĂ©finit la quantitĂ© d'items dans la pile (1 Ă  64). + * + * @param amount Le montant. + * @return Ce builder pour chaĂźnage. + */ + public ItemBuilder amount(int amount) { + this.itemStack.setAmount(Math.max(1, Math.min(64, amount))); + return this; + } + + /** + * DĂ©finit le nom d'affichage au format MiniMessage. + * + * @param miniMessage Le texte formatĂ© en MiniMessage. + * @return Ce builder. + */ + public ItemBuilder name(String miniMessage) { + if (meta != null && miniMessage != null) { + Component component = MiniMessage.miniMessage().deserialize(miniMessage); + meta.displayName(component); + } + return this; + } + + /** + * DĂ©finit le nom d'affichage avec un {@link Component} Adventure natif. + * + * @param component Le composant texte. + * @return Ce builder. + */ + public ItemBuilder name(Component component) { + if (meta != null && component != null) { + meta.displayName(component); + } + return this; + } + + /** + * DĂ©finit le lore complet Ă  partir de lignes MiniMessage. + * + * @param lines Les lignes de lore au format MiniMessage. + * @return Ce builder. + */ + public ItemBuilder lore(String... lines) { + return lore(Arrays.asList(lines)); + } + + /** + * DĂ©finit le lore complet Ă  partir d'une liste de chaĂźnes MiniMessage. + * + * @param lines La liste des lignes. + * @return Ce builder. + */ + public ItemBuilder lore(List lines) { + if (meta != null && lines != null) { + List components = lines.stream() + .map(line -> MiniMessage.miniMessage().deserialize(line)) + .collect(Collectors.toList()); + meta.lore(components); + } + return this; + } + + /** + * DĂ©finit le lore Ă  partir d'une liste de composants Adventure. + * + * @param components La liste des composants. + * @return Ce builder. + */ + public ItemBuilder loreComponents(List components) { + if (meta != null && components != null) { + meta.lore(components); + } + return this; + } + + /** + * Ajoute une ou plusieurs lignes au lore existant. + * + * @param lines Les lignes Ă  ajouter. + * @return Ce builder. + */ + public ItemBuilder addLore(String... lines) { + if (meta != null && lines != null) { + List current = meta.lore(); + if (current == null) { + current = new ArrayList<>(); + } else { + current = new ArrayList<>(current); + } + for (String line : lines) { + current.add(MiniMessage.miniMessage().deserialize(line)); + } + meta.lore(current); + } + return this; + } + + /** + * Ajoute un enchantement. + * + * @param enchantment L'enchantement. + * @param level Le niveau. + * @return Ce builder. + */ + public ItemBuilder enchant(Enchantment enchantment, int level) { + if (meta != null && enchantment != null) { + meta.addEnchant(enchantment, level, true); + } + return this; + } + + /** + * Donne un effet brillant (lueur d'enchantement) sans afficher de texte d'enchantement. + * + * @param glowing true pour activer la brillance. + * @return Ce builder. + */ + public ItemBuilder glowing(boolean glowing) { + if (glowing) { + enchant(Enchantment.LUCK, 1); + flags(ItemFlag.HIDE_ENCHANTS); + } + return this; + } + + /** + * Ajoute des drapeaux d'item (ItemFlags). + * + * @param flags Les drapeaux. + * @return Ce builder. + */ + public ItemBuilder flags(ItemFlag... flags) { + if (meta != null && flags != null) { + meta.addItemFlags(flags); + } + return this; + } + + /** + * Masque tous les attributs, enchantements et effets de potion de l'item. + * + * @return Ce builder. + */ + public ItemBuilder hideAll() { + if (meta != null) { + meta.addItemFlags(ItemFlag.values()); + } + return this; + } + + /** + * DĂ©finit le CustomModelData de l'item. + * + * @param customModelData L'identifiant numĂ©rique de modĂšle 3D. + * @return Ce builder. + */ + public ItemBuilder customModelData(int customModelData) { + if (meta != null) { + meta.setCustomModelData(customModelData); + } + return this; + } + + /** + * Marque l'item comme incassable. + * + * @param unbreakable true pour incassable. + * @return Ce builder. + */ + public ItemBuilder unbreakable(boolean unbreakable) { + if (meta != null) { + meta.setUnbreakable(unbreakable); + } + return this; + } + + /** + * Configure le propriĂ©taire d'une tĂȘte de joueur par son pseudo. + * + * @param playerName Le nom du joueur. + * @return Ce builder. + */ + public ItemBuilder skullOwner(String playerName) { + if (meta instanceof SkullMeta skullMeta && playerName != null) { + skullMeta.setOwner(playerName); + } + return this; + } + + /** + * Configure le propriĂ©taire d'une tĂȘte par UUID. + * + * @param uuid L'UUID du joueur. + * @return Ce builder. + */ + public ItemBuilder skullOwner(UUID uuid) { + if (meta instanceof SkullMeta skullMeta && uuid != null) { + skullMeta.setOwningPlayer(Bukkit.getOfflinePlayer(uuid)); + } + return this; + } + + /** + * DĂ©finit la couleur d'une piĂšce d'armure en cuir. + * + * @param color La couleur Bukkit. + * @return Ce builder. + */ + public ItemBuilder color(Color color) { + if (meta instanceof LeatherArmorMeta leatherMeta && color != null) { + leatherMeta.setColor(color); + } + return this; + } + + /** + * DĂ©finit la couleur RGB d'une armure en cuir. + * + * @param red 0-255 + * @param green 0-255 + * @param blue 0-255 + * @return Ce builder. + */ + public ItemBuilder color(int red, int green, int blue) { + return color(Color.fromRGB(red, green, blue)); + } + + /** + * Stocke une donnĂ©e texte dans le PersistentDataContainer. + * + * @param key La clĂ© NamespacedKey. + * @param value La valeur texte. + * @return Ce builder. + */ + public ItemBuilder pdcString(NamespacedKey key, String value) { + if (meta != null && key != null && value != null) { + meta.getPersistentDataContainer().set(key, PersistentDataType.STRING, value); + } + return this; + } + + /** + * Stocke un entier dans le PersistentDataContainer. + * + * @param key La clĂ© NamespacedKey. + * @param value La valeur entiĂšre. + * @return Ce builder. + */ + public ItemBuilder pdcInt(NamespacedKey key, int value) { + if (meta != null && key != null) { + meta.getPersistentDataContainer().set(key, PersistentDataType.INTEGER, value); + } + return this; + } + + /** + * Construit et retourne l'{@link ItemStack} configurĂ©. + * + * @return Le nouvel ItemStack. + */ + public ItemStack build() { + ItemStack item = itemStack.clone(); + if (meta != null) { + item.setItemMeta(meta); + } + return item; + } + + /** + * Convertit directement ce builder en {@link GuiItem} statique. + * + * @return L'instance de {@link GuiItem}. + */ + public GuiItem asGuiItem() { + return GuiItem.of(build()); + } + + /** + * Convertit directement ce builder en {@link GuiItem} avec une action de clic. + * + * @param clickAction L'action de clic Ă  exĂ©cuter. + * @return L'instance de {@link GuiItem}. + */ + public GuiItem asGuiItem(GuiClickAction clickAction) { + return GuiItem.of(build(), clickAction); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/PaginatedGuiBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/PaginatedGuiBuilder.java new file mode 100644 index 0000000..c4450ed --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/PaginatedGuiBuilder.java @@ -0,0 +1,199 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.event.GuiPageChangeEvent; +import fr.luc.bettermcguis.pattern.GuiMask; +import fr.luc.bettermcguis.type.PaginatedGui; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.function.BiFunction; +import java.util.function.Consumer; + +/** + * Constructeur fluide pour concevoir des inventaires paginĂ©s ({@link PaginatedGui}). + */ +public class PaginatedGuiBuilder extends GuiBuilder { + + private final List pageItems = new ArrayList<>(); + private final List itemSlots = new ArrayList<>(); + private Integer previousPageSlot; + private Integer nextPageSlot; + private Integer pageIndicatorSlot; + private GuiItem customPreviousButton; + private GuiItem customNextButton; + private BiFunction pageIndicatorSupplier; + private final List> pageChangeHooks = new ArrayList<>(); + + public PaginatedGuiBuilder() {} + + @Override + public PaginatedGuiBuilder title(String miniMessage) { + super.title(miniMessage); + return this; + } + + @Override + public PaginatedGuiBuilder type(GuiType type) { + super.type(type); + return this; + } + + @Override + public PaginatedGuiBuilder rows(int rows) { + super.rows(rows); + return this; + } + + @Override + public PaginatedGuiBuilder item(int slot, GuiItem item) { + super.item(slot, item); + return this; + } + + @Override + public PaginatedGuiBuilder fillBorder(GuiItem item) { + super.fillBorder(item); + return this; + } + + @Override + public PaginatedGuiBuilder fillBorder(org.bukkit.Material material) { + super.fillBorder(material); + return this; + } + + /** + * Ajoute un item paginĂ©. + */ + public PaginatedGuiBuilder addPageItem(GuiItem item) { + this.pageItems.add(item); + return this; + } + + /** + * Ajoute une collection complĂšte d'items paginĂ©s. + */ + public PaginatedGuiBuilder addPageItems(Collection items) { + if (items != null) { + this.pageItems.addAll(items); + } + return this; + } + + /** + * DĂ©finit les slots rĂ©servĂ©s pour les items paginĂ©s. + */ + public PaginatedGuiBuilder itemSlots(List slots) { + this.itemSlots.clear(); + if (slots != null) { + this.itemSlots.addAll(slots); + } + return this; + } + + /** + * DĂ©finit les slots d'items Ă  partir d'une plage {@link SlotRange}. + */ + public PaginatedGuiBuilder itemSlots(SlotRange range) { + if (range != null) { + itemSlots(range.getSlots()); + } + return this; + } + + /** + * DĂ©finit les slots d'items Ă  partir d'un masque {@link GuiMask}. + */ + public PaginatedGuiBuilder itemSlots(GuiMask mask) { + if (mask != null) { + itemSlots(mask.resolveSlots(type.getRows(), type.getColumns())); + } + return this; + } + + /** + * Configure le bouton de page prĂ©cĂ©dente. + */ + public PaginatedGuiBuilder previousButton(int slot, GuiItem item) { + this.previousPageSlot = slot; + this.customPreviousButton = item; + return this; + } + + /** + * Configure le bouton de page suivante. + */ + public PaginatedGuiBuilder nextButton(int slot, GuiItem item) { + this.nextPageSlot = slot; + this.customNextButton = item; + return this; + } + + /** + * Configure l'indicateur de page. + */ + public PaginatedGuiBuilder pageIndicator(int slot, BiFunction supplier) { + this.pageIndicatorSlot = slot; + this.pageIndicatorSupplier = supplier; + return this; + } + + /** + * Hook dĂ©clenchĂ© lors du changement de page. + */ + public PaginatedGuiBuilder onPageChange(Consumer hook) { + if (hook != null) { + this.pageChangeHooks.add(hook); + } + return this; + } + + @Override + public PaginatedGui build() { + PaginatedGui gui = new PaginatedGui(title, type); + + for (var entry : items.entrySet()) { + gui.setItem(entry.getKey(), entry.getValue()); + } + for (var pattern : patterns) { + gui.applyPattern(pattern); + } + for (int s : editableSlots) { + gui.setEditable(s, true); + } + for (var entry : properties.entrySet()) { + gui.setProperty(entry.getKey(), entry.getValue()); + } + + for (var hook : openHooks) gui.onOpen(hook); + for (var hook : closeHooks) gui.onClose(hook); + for (var hook : clickHooks) gui.onClick(hook); + for (var hook : outsideClickHooks) gui.onOutsideClick(hook); + for (var hook : bottomClickHooks) gui.onBottomClick(hook); + + if (!itemSlots.isEmpty()) { + gui.setItemSlots(itemSlots); + } + if (previousPageSlot != null) { + gui.setPreviousPageButton(previousPageSlot, customPreviousButton); + } + if (nextPageSlot != null) { + gui.setNextPageButton(nextPageSlot, customNextButton); + } + if (pageIndicatorSlot != null) { + gui.setPageIndicator(pageIndicatorSlot, pageIndicatorSupplier); + } + + gui.addPageItems(pageItems); + + for (var hook : pageChangeHooks) { + gui.onPageChange(hook); + } + + return gui; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/PatternBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/PatternBuilder.java new file mode 100644 index 0000000..2bf93ab --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/PatternBuilder.java @@ -0,0 +1,75 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.pattern.GuiPattern; +import org.bukkit.Material; +import org.bukkit.inventory.ItemStack; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * Constructeur fluide pour concevoir des motifs de placement ASCII ({@link GuiPattern}). + */ +public class PatternBuilder { + + private final List lines = new ArrayList<>(); + private final Map bindings = new HashMap<>(); + + public PatternBuilder() {} + + public PatternBuilder(String... lines) { + lines(lines); + } + + /** + * DĂ©finit les lignes du motif ASCII. + */ + public PatternBuilder lines(String... lines) { + if (lines != null) { + this.lines.addAll(Arrays.asList(lines)); + } + return this; + } + + /** + * Associe un caractĂšre Ă  un {@link GuiItem}. + */ + public PatternBuilder bind(char character, GuiItem item) { + this.bindings.put(character, item); + return this; + } + + /** + * Associe un caractĂšre Ă  un {@link ItemStack}. + */ + public PatternBuilder bind(char character, ItemStack itemStack) { + return bind(character, GuiItem.of(itemStack)); + } + + /** + * Associe un caractĂšre Ă  un matĂ©riau Bukkit simple. + */ + public PatternBuilder bind(char character, Material material) { + return bind(character, GuiItem.of(material)); + } + + /** + * Associe un caractĂšre Ă  un item de remplissage (vitrage avec nom vide). + */ + public PatternBuilder bindFiller(char character, Material material) { + return bind(character, GuiItem.filler(material)); + } + + /** + * Construit l'instance finale de {@link GuiPattern}. + */ + public GuiPattern build() { + GuiPattern pattern = new GuiPattern(lines); + pattern.bindAll(bindings); + return pattern; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/builder/TabbedGuiBuilder.java b/src/main/java/fr/luc/bettermcguis/builder/TabbedGuiBuilder.java new file mode 100644 index 0000000..b9ef97b --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/builder/TabbedGuiBuilder.java @@ -0,0 +1,95 @@ +package fr.luc.bettermcguis.builder; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.type.TabbedGui; + +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.function.Consumer; + +/** + * Constructeur fluide pour concevoir des inventaires Ă  onglets ({@link TabbedGui}). + */ +public class TabbedGuiBuilder extends GuiBuilder { + + private final Map tabButtons = new LinkedHashMap<>(); + private final Map tabButtonItems = new LinkedHashMap<>(); + private final Map> tabInitializers = new LinkedHashMap<>(); + + public TabbedGuiBuilder() {} + + @Override + public TabbedGuiBuilder title(String miniMessage) { + super.title(miniMessage); + return this; + } + + @Override + public TabbedGuiBuilder type(GuiType type) { + super.type(type); + return this; + } + + @Override + public TabbedGuiBuilder rows(int rows) { + super.rows(rows); + return this; + } + + /** + * Enregistre un onglet avec son bouton et sa configuration d'items. + * + * @param tabId L'identifiant de l'onglet. + * @param buttonSlot Le slot du bouton d'onglet. + * @param buttonItem L'item visuel du bouton. + * @param tabConfig La configuration des items de cet onglet. + * @return Ce builder pour chaĂźnage. + */ + public TabbedGuiBuilder tab(String tabId, int buttonSlot, GuiItem buttonItem, Consumer tabConfig) { + this.tabButtons.put(tabId, buttonSlot); + this.tabButtonItems.put(tabId, buttonItem); + if (tabConfig != null) { + this.tabInitializers.put(tabId, tabConfig); + } + return this; + } + + @Override + public TabbedGui build() { + TabbedGui gui = new TabbedGui(title, type); + + for (var entry : items.entrySet()) { + gui.setItem(entry.getKey(), entry.getValue()); + } + for (var pattern : patterns) { + gui.applyPattern(pattern); + } + for (int s : editableSlots) { + gui.setEditable(s, true); + } + for (var entry : properties.entrySet()) { + gui.setProperty(entry.getKey(), entry.getValue()); + } + + for (var hook : openHooks) gui.onOpen(hook); + for (var hook : closeHooks) gui.onClose(hook); + for (var hook : clickHooks) gui.onClick(hook); + for (var hook : outsideClickHooks) gui.onOutsideClick(hook); + for (var hook : bottomClickHooks) gui.onBottomClick(hook); + + for (var entry : tabButtons.entrySet()) { + String tabId = entry.getKey(); + int slot = entry.getValue(); + GuiItem item = tabButtonItems.get(tabId); + gui.addTab(tabId, slot, item); + + Consumer init = tabInitializers.get(tabId); + if (init != null) { + init.accept(gui); + } + } + + return gui; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/demo/DemoGuiPlugin.java b/src/main/java/fr/luc/bettermcguis/demo/DemoGuiPlugin.java new file mode 100644 index 0000000..df584bc --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/demo/DemoGuiPlugin.java @@ -0,0 +1,53 @@ +package fr.luc.bettermcguis.demo; + +import fr.luc.bettermcguis.BetterMcGuis; +import fr.luc.bettermcguis.demo.guis.DemoMainMenuGui; +import fr.luc.bettermcguis.demo.listeners.DemoGuiListener; +import org.bukkit.command.Command; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.Player; +import org.bukkit.plugin.java.JavaPlugin; + +/** + * Plugin de dĂ©monstration montrant l'initialisation de betterMcGuis, + * l'enregistrement d'Ă©couteurs et l'ouverture de menus via commande. + */ +public class DemoGuiPlugin extends JavaPlugin implements CommandExecutor { + + private BetterMcGuis guiManager; + + @Override + public void onEnable() { + // Initialisation de betterMcGuis + this.guiManager = BetterMcGuis.create(this); + + // Enregistrement des listeners d'audit + this.guiManager.registerListeners(new DemoGuiListener()); + + // Enregistrement d'une commande /menu pour ouvrir le GUI + if (getCommand("menu") != null) { + getCommand("menu").setExecutor(this); + } + + getLogger().info("betterMcGuis DemoPlugin active avec succes !"); + } + + @Override + public void onDisable() { + if (guiManager != null) { + guiManager.unregisterAll(); + } + getLogger().info("betterMcGuis DemoPlugin desactive."); + } + + @Override + public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { + if (sender instanceof Player player) { + DemoMainMenuGui.create().open(player); + return true; + } + sender.sendMessage("Seul un joueur peut ouvrir ce menu."); + return true; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/demo/guis/DemoMainMenuGui.java b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoMainMenuGui.java new file mode 100644 index 0000000..359e0b4 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoMainMenuGui.java @@ -0,0 +1,65 @@ +package fr.luc.bettermcguis.demo.guis; + +import fr.luc.bettermcguis.BetterMcGuis; +import fr.luc.bettermcguis.api.Gui; +import fr.luc.bettermcguis.builder.ItemBuilder; +import org.bukkit.Material; +import org.bukkit.Sound; + +/** + * Menu principal de dĂ©monstration illustrant la crĂ©ation d'un GUI interactif moderne. + */ +public class DemoMainMenuGui { + + public static Gui create() { + return BetterMcGuis.builder() + .title("Menu Principal DĂ©mo") + .rows(3) + .fillBorder(Material.BLACK_STAINED_GLASS_PANE) + + // Bouton 1 : Boutique PaginĂ©e + .item(11, ItemBuilder.of(Material.EMERALD) + .name("Boutique du Serveur") + .lore( + "Parcourez notre catalogue d'items.", + "", + "▶ Cliquez pour ouvrir la boutique" + ) + .glowing(true) + .asGuiItem(ctx -> { + ctx.playSound(Sound.ENTITY_EXPERIENCE_ORB_PICKUP, 1.0f, 1.2f); + DemoPaginatedShopGui.create().open(ctx.getPlayer()); + }) + ) + + // Bouton 2 : Poubelle / Recyclage + .item(13, ItemBuilder.of(Material.CAULDRON) + .name("Poubelle / DĂ©barras") + .lore( + "DĂ©posez vos items indĂ©sirables ici.", + "", + "▶ Cliquez pour ouvrir la poubelle" + ) + .asGuiItem(ctx -> { + ctx.playSound(Sound.BLOCK_CHEST_OPEN, 1.0f, 1.0f); + DemoStorageTrashGui.create().open(ctx.getPlayer()); + }) + ) + + // Bouton 3 : Profil & Statistiques + .item(15, ItemBuilder.skull() + .name("Votre Profil") + .lore( + "Consultez vos statistiques personnelles.", + "", + "▶ Cliquez pour actualiser" + ) + .asGuiItem(ctx -> { + ctx.playSound(Sound.UI_BUTTON_CLICK, 1.0f, 1.0f); + ctx.replySuccess("Votre profil est Ă  jour !"); + }) + ) + + .build(); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/demo/guis/DemoPaginatedShopGui.java b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoPaginatedShopGui.java new file mode 100644 index 0000000..9807a64 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoPaginatedShopGui.java @@ -0,0 +1,58 @@ +package fr.luc.bettermcguis.demo.guis; + +import fr.luc.bettermcguis.BetterMcGuis; +import fr.luc.bettermcguis.api.Gui; +import fr.luc.bettermcguis.builder.ItemBuilder; +import org.bukkit.Material; +import org.bukkit.Sound; + +/** + * Menu de boutique paginĂ© de dĂ©monstration avec items interactifs et boutons de navigation. + */ +public class DemoPaginatedShopGui { + + public static Gui create() { + fr.luc.bettermcguis.builder.PaginatedGuiBuilder builder = BetterMcGuis.paginated() + .title("Boutique PaginĂ©e") + .rows(5) + .fillBorder(Material.GRAY_STAINED_GLASS_PANE); + + // Bouton retour au menu principal en bas Ă  gauche + builder.item(36, ItemBuilder.of(Material.BARRIER) + .name("Retour au Menu Principal") + .asGuiItem(ctx -> { + ctx.playSound(Sound.UI_BUTTON_CLICK, 1.0f, 0.8f); + DemoMainMenuGui.create().open(ctx.getPlayer()); + }) + ); + + // GĂ©nĂšre 50 articles dans le catalogue paginĂ© + Material[] sampleMaterials = new Material[]{ + Material.DIAMOND, Material.NETHERITE_INGOT, Material.GOLDEN_APPLE, Material.ENCHANTED_GOLDEN_APPLE, + Material.ELYTRA, Material.TOTEM_OF_UNDYING, Material.EXPERIENCE_BOTTLE, Material.BEACON, + Material.SHULKER_BOX, Material.NETHER_STAR, Material.ENDER_PEARL, Material.BLAZE_ROD, + Material.TRIDENT, Material.NETHERITE_SWORD, Material.BOW, Material.CROSSBOW + }; + + for (int i = 1; i <= 40; i++) { + Material mat = sampleMaterials[(i - 1) % sampleMaterials.length]; + int price = i * 100; + int itemId = i; + + builder.addPageItem(ItemBuilder.of(mat) + .name("Article #" + itemId + "") + .lore( + "Prix : " + price + " $", + "", + "▶ Clic-gauche pour acheter" + ) + .asGuiItem(ctx -> { + ctx.playSound(Sound.ENTITY_PLAYER_LEVELUP, 1.0f, 1.5f); + ctx.replySuccess("Vous avez achetĂ© Article #" + itemId + " pour " + price + " $ !"); + }) + ); + } + + return builder.build(); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/demo/guis/DemoStorageTrashGui.java b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoStorageTrashGui.java new file mode 100644 index 0000000..5901ee1 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/demo/guis/DemoStorageTrashGui.java @@ -0,0 +1,46 @@ +package fr.luc.bettermcguis.demo.guis; + +import fr.luc.bettermcguis.api.Gui; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.builder.ItemBuilder; +import fr.luc.bettermcguis.type.StorageGui; +import org.bukkit.Material; +import org.bukkit.Sound; + +/** + * Menu de poubelle / zone de dĂ©pĂŽt de dĂ©monstration (StorageGui) permettant de dĂ©truire des items. + */ +public class DemoStorageTrashGui { + + public static Gui create() { + StorageGui gui = new StorageGui("Poubelle Publique", GuiType.CHEST_4_ROWS); + + // Remplit les bordures avec du vitrage rouge + gui.fillBorder(ItemBuilder.filler(Material.RED_STAINED_GLASS_PANE).asGuiItem()); + + // DĂ©finit l'intĂ©rieur comme zone de stockage Ă©ditable + gui.setStorageSlots(SlotRange.interior(4, 9)); + gui.returnItemsOnClose(false); // DĂ©truit dĂ©finitivement les items Ă  la fermeture + + // Bouton de vidage immĂ©diat en bas au centre + gui.setItem(31, ItemBuilder.of(Material.LAVA_BUCKET) + .name("Vider la Poubelle ImmĂ©diatement") + .lore( + "DĂ©truit tous les objets placĂ©s dans la zone centrale.", + "", + "▶ Cliquez pour incinĂ©rer les items" + ) + .asGuiItem(ctx -> { + ctx.playSound(Sound.BLOCK_LAVA_EXTINGUISH, 1.0f, 1.0f); + var topInv = ctx.getPlayer().getOpenInventory().getTopInventory(); + for (int slot : SlotRange.interior(4, 9).getSlots()) { + topInv.setItem(slot, null); + } + ctx.replySuccess("La poubelle a Ă©tĂ© vidĂ©e et les items ont Ă©tĂ© incinĂ©rĂ©s !"); + }) + ); + + return gui; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/demo/listeners/DemoGuiListener.java b/src/main/java/fr/luc/bettermcguis/demo/listeners/DemoGuiListener.java new file mode 100644 index 0000000..bdc27ab --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/demo/listeners/DemoGuiListener.java @@ -0,0 +1,36 @@ +package fr.luc.bettermcguis.demo.listeners; + +import fr.luc.bettermcguis.event.GuiClickEvent; +import fr.luc.bettermcguis.event.GuiCloseEvent; +import fr.luc.bettermcguis.event.GuiOpenEvent; +import fr.luc.bettermcguis.event.GuiPageChangeEvent; +import fr.luc.bettermcguis.event.annotation.GuiEventHandler; + +/** + * Écouteur global de dĂ©monstration illustrant la capture d'Ă©vĂ©nements de GUI avec {@link GuiEventHandler}. + */ +public class DemoGuiListener { + + @GuiEventHandler(priority = 10) + public void onOpen(GuiOpenEvent event) { + System.out.println("[GUI Log] Ouverture du menu '" + event.getGui().getTitle() + "' pour " + event.getPlayer().getName()); + } + + @GuiEventHandler + public void onClose(GuiCloseEvent event) { + System.out.println("[GUI Log] Fermeture du menu '" + event.getGui().getTitle() + "' par " + event.getPlayer().getName()); + } + + @GuiEventHandler + public void onClick(GuiClickEvent event) { + var ctx = event.getContext(); + if (ctx.getGuiItem() != null) { + System.out.println("[GUI Log] Clic sur slot #" + ctx.getSlot() + " (" + ctx.getClickType() + ") par " + ctx.getPlayer().getName()); + } + } + + @GuiEventHandler + public void onPageChange(GuiPageChangeEvent event) { + System.out.println("[GUI Log] Changement de page : " + event.getOldPage() + " -> " + event.getNewPage()); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/CancellableGuiEvent.java b/src/main/java/fr/luc/bettermcguis/event/CancellableGuiEvent.java new file mode 100644 index 0000000..725ace1 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/CancellableGuiEvent.java @@ -0,0 +1,32 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; + +/** + * Classe de base pour les Ă©vĂ©nements de GUI pouvant ĂȘtre annulĂ©s. + */ +public abstract class CancellableGuiEvent extends GuiEvent { + + private boolean cancelled = false; + + public CancellableGuiEvent(Gui gui, Player player) { + super(gui, player); + } + + /** + * @return true si l'Ă©vĂ©nement a Ă©tĂ© annulĂ©, sinon false. + */ + public boolean isCancelled() { + return cancelled; + } + + /** + * DĂ©finit si l'Ă©vĂ©nement doit ĂȘtre annulĂ©. + * + * @param cancelled true pour interrompre l'action. + */ + public void setCancelled(boolean cancelled) { + this.cancelled = cancelled; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiClickEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiClickEvent.java new file mode 100644 index 0000000..31d68b6 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiClickEvent.java @@ -0,0 +1,27 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.GuiClickContext; + +/** + * DĂ©clenchĂ© lors d'une interaction / clic d'un joueur dans un inventaire GUI. + */ +public class GuiClickEvent extends CancellableGuiEvent { + + private final GuiClickContext context; + + public GuiClickEvent(GuiClickContext context) { + super(context.getGui(), context.getPlayer()); + this.context = context; + this.setCancelled(context.isCancelled()); + } + + public GuiClickContext getContext() { + return context; + } + + @Override + public void setCancelled(boolean cancelled) { + super.setCancelled(cancelled); + context.setCancelled(cancelled); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiCloseEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiCloseEvent.java new file mode 100644 index 0000000..618e51e --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiCloseEvent.java @@ -0,0 +1,22 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.InventoryCloseEvent; + +/** + * DĂ©clenchĂ© lors de la fermeture d'un GUI par un joueur. + */ +public class GuiCloseEvent extends GuiEvent { + + private final InventoryCloseEvent rawEvent; + + public GuiCloseEvent(Gui gui, Player player, InventoryCloseEvent rawEvent) { + super(gui, player); + this.rawEvent = rawEvent; + } + + public InventoryCloseEvent getRawEvent() { + return rawEvent; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiEvent.java new file mode 100644 index 0000000..caf457a --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiEvent.java @@ -0,0 +1,34 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; + +import java.util.Objects; + +/** + * Classe abstraite de base pour tous les Ă©vĂ©nements du cycle de vie des GUIs. + */ +public abstract class GuiEvent { + + protected final Gui gui; + protected final Player player; + + public GuiEvent(Gui gui, Player player) { + this.gui = Objects.requireNonNull(gui, "gui cannot be null"); + this.player = player; + } + + /** + * @return L'instance de {@link Gui} concernĂ©e par l'Ă©vĂ©nement. + */ + public Gui getGui() { + return gui; + } + + /** + * @return Le joueur concernĂ©, ou {@code null} pour un Ă©vĂ©nement global. + */ + public Player getPlayer() { + return player; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiEventListener.java b/src/main/java/fr/luc/bettermcguis/event/GuiEventListener.java new file mode 100644 index 0000000..263d2b3 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiEventListener.java @@ -0,0 +1,17 @@ +package fr.luc.bettermcguis.event; + +/** + * Interface fonctionnelle pour Ă©couter un Ă©vĂ©nement spĂ©cifique de GUI. + * + * @param Le type d'Ă©vĂ©nement Ă©coutĂ©. + */ +@FunctionalInterface +public interface GuiEventListener { + + /** + * Traite l'Ă©vĂ©nement transmis. + * + * @param event L'instance de l'Ă©vĂ©nement. + */ + void onEvent(T event); +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiEventManager.java b/src/main/java/fr/luc/bettermcguis/event/GuiEventManager.java new file mode 100644 index 0000000..2be9f5e --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiEventManager.java @@ -0,0 +1,112 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.event.annotation.GuiEventHandler; + +import java.lang.reflect.Method; +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CopyOnWriteArrayList; + +/** + * Bus d'Ă©vĂ©nements central gĂ©rant l'enregistrement et la distribution des Ă©vĂ©nements de GUI. + */ +public class GuiEventManager { + + private record RegisteredListener( + Class eventType, + int priority, + String titleFilter, + GuiEventListener listener + ) implements Comparable { + @Override + public int compareTo(RegisteredListener o) { + return Integer.compare(o.priority, this.priority); // Ordre dĂ©croissant + } + } + + private final Map, List> listeners = new ConcurrentHashMap<>(); + + /** + * Enregistre un Ă©couteur programmatique avec une prioritĂ© par dĂ©faut de 0. + */ + public void registerListener(Class eventType, GuiEventListener listener) { + registerListener(eventType, 0, "", listener); + } + + /** + * Enregistre un Ă©couteur programmatique avec prioritĂ© et filtre de titre. + */ + public void registerListener(Class eventType, int priority, String titleFilter, GuiEventListener listener) { + Objects.requireNonNull(eventType, "eventType cannot be null"); + Objects.requireNonNull(listener, "listener cannot be null"); + + RegisteredListener reg = new RegisteredListener(eventType, priority, titleFilter != null ? titleFilter : "", listener); + listeners.computeIfAbsent(eventType, k -> new CopyOnWriteArrayList<>()).add(reg); + listeners.get(eventType).sort(RegisteredListener::compareTo); + } + + /** + * Scanne et enregistre les mĂ©thodes annotĂ©es {@link GuiEventHandler} d'un objet Ă©couteur. + * + * @param listenerInstance L'instance de classe contenant les mĂ©thodes d'Ă©coute. + */ + @SuppressWarnings("unchecked") + public void registerListeners(Object listenerInstance) { + if (listenerInstance == null) return; + + for (Method method : listenerInstance.getClass().getDeclaredMethods()) { + if (method.isAnnotationPresent(GuiEventHandler.class)) { + Class[] params = method.getParameterTypes(); + if (params.length == 1 && GuiEvent.class.isAssignableFrom(params[0])) { + Class eventType = (Class) params[0]; + GuiEventHandler annotation = method.getAnnotation(GuiEventHandler.class); + + method.setAccessible(true); + GuiEventListener listener = event -> { + try { + method.invoke(listenerInstance, event); + } catch (Exception e) { + e.printStackTrace(); + } + }; + + registerListener(eventType, annotation.priority(), annotation.guiTitle(), (GuiEventListener) listener); + } + } + } + } + + /** + * Distribue un Ă©vĂ©nement Ă  tous les Ă©couteurs enregistrĂ©s correspondants. + * + * @param event L'Ă©vĂ©nement Ă  diffuser. + */ + @SuppressWarnings("unchecked") + public void dispatch(GuiEvent event) { + if (event == null) return; + + Class clazz = event.getClass(); + for (Map.Entry, List> entry : listeners.entrySet()) { + if (entry.getKey().isAssignableFrom(clazz)) { + for (RegisteredListener reg : entry.getValue()) { + if (!reg.titleFilter().isEmpty() && !event.getGui().getTitle().equalsIgnoreCase(reg.titleFilter())) { + continue; + } + + try { + ((GuiEventListener) reg.listener()).onEvent(event); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + } + } + + /** + * Supprime tous les Ă©couteurs enregistrĂ©s. + */ + public void clear() { + listeners.clear(); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiOpenEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiOpenEvent.java new file mode 100644 index 0000000..ea16a03 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiOpenEvent.java @@ -0,0 +1,22 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.InventoryOpenEvent; + +/** + * DĂ©clenchĂ© avant l'ouverture d'un GUI pour un joueur. Peut ĂȘtre annulĂ©. + */ +public class GuiOpenEvent extends CancellableGuiEvent { + + private final InventoryOpenEvent rawEvent; + + public GuiOpenEvent(Gui gui, Player player, InventoryOpenEvent rawEvent) { + super(gui, player); + this.rawEvent = rawEvent; + } + + public InventoryOpenEvent getRawEvent() { + return rawEvent; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiPageChangeEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiPageChangeEvent.java new file mode 100644 index 0000000..de0da44 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiPageChangeEvent.java @@ -0,0 +1,27 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; + +/** + * DĂ©clenchĂ© lors d'un changement de page dans un menu paginĂ© (PaginatedGui). + */ +public class GuiPageChangeEvent extends GuiEvent { + + private final int oldPage; + private final int newPage; + + public GuiPageChangeEvent(Gui gui, Player player, int oldPage, int newPage) { + super(gui, player); + this.oldPage = oldPage; + this.newPage = newPage; + } + + public int getOldPage() { + return oldPage; + } + + public int getNewPage() { + return newPage; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/GuiRefreshEvent.java b/src/main/java/fr/luc/bettermcguis/event/GuiRefreshEvent.java new file mode 100644 index 0000000..4c14bb1 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/GuiRefreshEvent.java @@ -0,0 +1,14 @@ +package fr.luc.bettermcguis.event; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; + +/** + * DĂ©clenchĂ© lors du rafraĂźchissement d'un GUI pour un joueur. + */ +public class GuiRefreshEvent extends GuiEvent { + + public GuiRefreshEvent(Gui gui, Player player) { + super(gui, player); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/event/annotation/GuiEventHandler.java b/src/main/java/fr/luc/bettermcguis/event/annotation/GuiEventHandler.java new file mode 100644 index 0000000..bbaa851 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/event/annotation/GuiEventHandler.java @@ -0,0 +1,24 @@ +package fr.luc.bettermcguis.event.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation permettant de marquer une mĂ©thode comme Ă©couteur d'Ă©vĂ©nements du cycle de vie des GUIs. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface GuiEventHandler { + + /** + * PrioritĂ© d'exĂ©cution de l'Ă©couteur (les valeurs les plus Ă©levĂ©es sont exĂ©cutĂ©es en premier). + */ + int priority() default 0; + + /** + * Filtre optionnel sur le titre du GUI (si renseignĂ©, seuls les GUIs dont le titre correspond dĂ©clencheront la mĂ©thode). + */ + String guiTitle() default ""; +} diff --git a/src/main/java/fr/luc/bettermcguis/holder/BetterGuiHolder.java b/src/main/java/fr/luc/bettermcguis/holder/BetterGuiHolder.java new file mode 100644 index 0000000..6fade19 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/holder/BetterGuiHolder.java @@ -0,0 +1,59 @@ +package fr.luc.bettermcguis.holder; + +import fr.luc.bettermcguis.api.Gui; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; +import org.bukkit.inventory.InventoryHolder; + +import java.util.Objects; +import java.util.UUID; + +/** + * ImplĂ©mentation personnalisĂ©e d'{@link InventoryHolder} permettant d'associer + * un inventaire Bukkit/Paper natif Ă  une instance de {@link Gui} de la bibliothĂšque betterMcGuis. + */ +public class BetterGuiHolder implements InventoryHolder { + + private final Gui gui; + private final UUID viewerUuid; + private Inventory inventory; + + /** + * CrĂ©e un nouveau holder reliant un GUI Ă  son visualisateur. + * + * @param gui Le GUI associĂ©. + * @param viewer Le joueur visualisant l'inventaire. + */ + public BetterGuiHolder(Gui gui, Player viewer) { + this.gui = Objects.requireNonNull(gui, "gui cannot be null"); + this.viewerUuid = viewer != null ? viewer.getUniqueId() : null; + } + + /** + * @return L'instance de {@link Gui} sous-jacente. + */ + public Gui getGui() { + return gui; + } + + /** + * @return L'UUID du joueur visualisant le GUI. + */ + public UUID getViewerUuid() { + return viewerUuid; + } + + /** + * DĂ©finit l'inventaire Bukkit crĂ©Ă© pour ce holder. + * + * @param inventory L'inventaire Bukkit. + */ + public void setInventory(Inventory inventory) { + this.inventory = inventory; + } + + @Override + public Inventory getInventory() { + return inventory; + } +} diff --git a/src/main/java/fr/luc/bettermcguis/listener/BukkitGuiEventListener.java b/src/main/java/fr/luc/bettermcguis/listener/BukkitGuiEventListener.java new file mode 100644 index 0000000..b151b71 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/listener/BukkitGuiEventListener.java @@ -0,0 +1,162 @@ +package fr.luc.bettermcguis.listener; + +import fr.luc.bettermcguis.BetterMcGuis; +import fr.luc.bettermcguis.api.*; +import fr.luc.bettermcguis.api.slot.SlotPos; +import fr.luc.bettermcguis.event.GuiClickEvent; +import fr.luc.bettermcguis.event.GuiCloseEvent; +import fr.luc.bettermcguis.event.GuiOpenEvent; +import fr.luc.bettermcguis.holder.BetterGuiHolder; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.EventPriority; +import org.bukkit.event.Listener; +import org.bukkit.event.inventory.*; +import org.bukkit.inventory.Inventory; + +/** + * Écouteur Bukkit central interceptant de maniĂšre sĂ©curisĂ©e toutes les interactions d'inventaires + * pour les acheminer vers les instances de {@link Gui} et le bus d'Ă©vĂ©nements de betterMcGuis. + */ +public class BukkitGuiEventListener implements Listener { + + private final BetterMcGuis manager; + + public BukkitGuiEventListener(BetterMcGuis manager) { + this.manager = manager; + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false) + public void onInventoryClick(InventoryClickEvent event) { + if (!(event.getWhoClicked() instanceof Player player)) { + return; + } + + Inventory topInventory = event.getView().getTopInventory(); + if (!(topInventory.getHolder() instanceof BetterGuiHolder holder)) { + return; + } + + Gui gui = holder.getGui(); + int rawSlot = event.getRawSlot(); + + // 1. Clic en dehors de la fenĂȘtre d'inventaire + if (rawSlot == -999 || event.getSlotType() == InventoryType.SlotType.OUTSIDE) { + GuiClickContext context = new GuiClickContext( + player, gui, null, -999, null, + event.getClick(), event.getAction(), + null, event.getCursor(), event + ); + gui.handleOutsideClick(context); + manager.getEventManager().dispatch(new GuiClickEvent(context)); + return; + } + + // 2. Clic dans l'inventaire supĂ©rieur (Le GUI lui-mĂȘme) + if (rawSlot < topInventory.getSize() && rawSlot >= 0) { + boolean editable = gui.isEditable(rawSlot); + GuiItem item = gui.getItem(rawSlot); + + SlotPos pos = SlotPos.fromSlot(rawSlot, gui.getColumns()); + GuiClickContext context = new GuiClickContext( + player, gui, item, rawSlot, pos, + event.getClick(), event.getAction(), + event.getCurrentItem(), event.getCursor(), event + ); + + // Si le slot n'est pas explicitement Ă©ditable, on bloque l'interaction native + if (!editable) { + event.setCancelled(true); + context.setCancelled(true); + } else { + context.setCancelled(false); + } + + if (item != null) { + item.handleClick(context); + } + + gui.handleClick(context); + manager.getEventManager().dispatch(new GuiClickEvent(context)); + return; + } + + // 3. Clic dans l'inventaire infĂ©rieur (Inventaire du joueur) + if (rawSlot >= topInventory.getSize()) { + // SĂ©curitĂ© : EmpĂȘche le Shift-Clic d'injecter des items dans des slots non Ă©ditables du GUI + if (event.isShiftClick()) { + boolean hasEditableSlots = !gui.getEditableSlots().isEmpty(); + if (!hasEditableSlots) { + event.setCancelled(true); + } + } + + // SĂ©curitĂ© : Échange par touche numĂ©rique (Hotbar Number Key Swap) + if (event.getClick() == ClickType.NUMBER_KEY) { + // Bloque si le slot visĂ© n'est pas Ă©ditable + if (rawSlot < topInventory.getSize() && !gui.isEditable(rawSlot)) { + event.setCancelled(true); + } + } + + GuiClickContext context = new GuiClickContext( + player, gui, null, event.getSlot(), null, + event.getClick(), event.getAction(), + event.getCurrentItem(), event.getCursor(), event + ); + gui.handleBottomClick(context); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false) + public void onInventoryDrag(InventoryDragEvent event) { + if (!(event.getWhoClicked() instanceof Player player)) { + return; + } + + Inventory topInventory = event.getView().getTopInventory(); + if (!(topInventory.getHolder() instanceof BetterGuiHolder holder)) { + return; + } + + Gui gui = holder.getGui(); + + // VĂ©rifie si l'un des slots touchĂ©s par le glisser-dĂ©poser appartient au GUI supĂ©rieur + for (int rawSlot : event.getRawSlots()) { + if (rawSlot < topInventory.getSize()) { + if (!gui.isEditable(rawSlot)) { + event.setCancelled(true); + return; + } + } + } + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onInventoryOpen(InventoryOpenEvent event) { + if (!(event.getPlayer() instanceof Player player)) { + return; + } + + if (event.getInventory().getHolder() instanceof BetterGuiHolder holder) { + Gui gui = holder.getGui(); + GuiOpenContext context = new GuiOpenContext(player, gui, event); + gui.handleOpen(context); + manager.getEventManager().dispatch(new GuiOpenEvent(gui, player, event)); + } + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onInventoryClose(InventoryCloseEvent event) { + if (!(event.getPlayer() instanceof Player player)) { + return; + } + + if (event.getInventory().getHolder() instanceof BetterGuiHolder holder) { + Gui gui = holder.getGui(); + GuiCloseContext context = new GuiCloseContext(player, gui, event); + gui.handleClose(context); + manager.getEventManager().dispatch(new GuiCloseEvent(gui, player, event)); + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/pattern/GuiMask.java b/src/main/java/fr/luc/bettermcguis/pattern/GuiMask.java new file mode 100644 index 0000000..14a12c3 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/pattern/GuiMask.java @@ -0,0 +1,55 @@ +package fr.luc.bettermcguis.pattern; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +/** + * ReprĂ©sente un masque de sĂ©lection de slots basĂ© sur des lignes de caractĂšres binaires (0 et 1 ou caractĂšres au choix). + */ +public class GuiMask { + + private final List lines = new ArrayList<>(); + private final char activeChar; + + /** + * CrĂ©e un masque avec '1' comme caractĂšre actif par dĂ©faut. + */ + public GuiMask(String... lines) { + this('1', lines); + } + + /** + * CrĂ©e un masque en prĂ©cisant le caractĂšre actif. + * + * @param activeChar Le caractĂšre reprĂ©sentant un slot sĂ©lectionnĂ©. + * @param lines Les lignes du masque. + */ + public GuiMask(char activeChar, String... lines) { + this.activeChar = activeChar; + if (lines != null) { + this.lines.addAll(Arrays.asList(lines)); + } + } + + /** + * RĂ©sout la liste des slots sĂ©lectionnĂ©s par ce masque pour des dimensions donnĂ©es. + * + * @param rows Le nombre de lignes. + * @param cols Le nombre de colonnes (ex: 9). + * @return La liste des slots actifs (0-indexĂ©s). + */ + public List resolveSlots(int rows, int cols) { + List slots = new ArrayList<>(); + for (int r = 0; r < Math.min(lines.size(), rows); r++) { + String line = lines.get(r); + for (int c = 0; c < Math.min(line.length(), cols); c++) { + if (line.charAt(c) == activeChar) { + slots.add(r * cols + c); + } + } + } + return Collections.unmodifiableList(slots); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/pattern/GuiPattern.java b/src/main/java/fr/luc/bettermcguis/pattern/GuiPattern.java new file mode 100644 index 0000000..83c1198 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/pattern/GuiPattern.java @@ -0,0 +1,108 @@ +package fr.luc.bettermcguis.pattern; + +import fr.luc.bettermcguis.api.Gui; +import fr.luc.bettermcguis.api.GuiItem; + +import java.util.*; + +/** + * Permet de dĂ©finir la disposition visuelle d'un GUI sous forme d'une matrice textuelle ASCII (pattern). + * Chaque caractĂšre de la matrice est associĂ© Ă  un {@link GuiItem}. + */ +public class GuiPattern { + + private final List rows = new ArrayList<>(); + private final Map itemBindings = new HashMap<>(); + + /** + * CrĂ©e un pattern Ă  partir des lignes fournies. + * + * @param lines Les lignes de texte reprĂ©sentant la grille de l'inventaire. + */ + public GuiPattern(String... lines) { + if (lines != null) { + this.rows.addAll(Arrays.asList(lines)); + } + } + + /** + * CrĂ©e un pattern Ă  partir d'une liste de lignes. + */ + public GuiPattern(List lines) { + if (lines != null) { + this.rows.addAll(lines); + } + } + + /** + * Fabrique statique pour crĂ©er un pattern. + * + * @param lines Les lignes du motif. + * @return L'instance de {@link GuiPattern}. + */ + public static GuiPattern of(String... lines) { + return new GuiPattern(lines); + } + + /** + * Associe un caractĂšre Ă  un {@link GuiItem}. + * + * @param character Le caractĂšre de la grille (ex: '#', 'X', 'A'). + * @param item L'item correspondant. + * @return Cette instance de pattern pour chaĂźnage. + */ + public GuiPattern bind(char character, GuiItem item) { + this.itemBindings.put(character, item); + return this; + } + + /** + * Associe plusieurs bindings Ă  la fois. + * + * @param bindings La table de mapping caractĂšre -> GuiItem. + * @return Cette instance. + */ + public GuiPattern bindAll(Map bindings) { + if (bindings != null) { + this.itemBindings.putAll(bindings); + } + return this; + } + + /** + * Applique ce motif sur l'inventaire GUI cible. + * + * @param gui Le GUI sur lequel placer les items selon la matrice. + */ + public void apply(Gui gui) { + Objects.requireNonNull(gui, "gui cannot be null"); + int cols = gui.getColumns(); + int maxRows = gui.getRows(); + + for (int r = 0; r < Math.min(rows.size(), maxRows); r++) { + String line = rows.get(r); + for (int c = 0; c < Math.min(line.length(), cols); c++) { + char ch = line.charAt(c); + if (itemBindings.containsKey(ch)) { + GuiItem item = itemBindings.get(ch); + int slot = r * cols + c; + gui.setItem(slot, item); + } + } + } + } + + /** + * @return La liste des lignes du motif. + */ + public List getRows() { + return Collections.unmodifiableList(rows); + } + + /** + * @return La table des liaisons de caractĂšres vers items. + */ + public Map getItemBindings() { + return Collections.unmodifiableMap(itemBindings); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/type/AnimatedGui.java b/src/main/java/fr/luc/bettermcguis/type/AnimatedGui.java new file mode 100644 index 0000000..b2be017 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/type/AnimatedGui.java @@ -0,0 +1,122 @@ +package fr.luc.bettermcguis.type; + +import fr.luc.bettermcguis.animation.Frame; +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.plugin.Plugin; +import org.bukkit.scheduler.BukkitTask; + +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** + * ImplĂ©mentation d'un GUI animĂ© cadencĂ© par une tĂąche Bukkit (frames multiples, titres mouvants, carrousels). + */ +public class AnimatedGui extends SimpleGui { + + private final List frames = new ArrayList<>(); + private int currentFrameIndex = 0; + private BukkitTask animationTask; + private boolean loop = true; + + public AnimatedGui(String title, GuiType type) { + super(title, type); + } + + public AnimatedGui(String title, int rows) { + super(title, rows); + } + + /** + * Ajoute une frame Ă  la sĂ©quence d'animation. + * + * @param frame La frame. + * @return Ce GUI pour chaĂźnage. + */ + public AnimatedGui addFrame(Frame frame) { + if (frame != null) { + this.frames.add(frame); + } + return this; + } + + /** + * DĂ©finit si l'animation doit tourner en boucle continue. + */ + public AnimatedGui loop(boolean loop) { + this.loop = loop; + return this; + } + + /** + * DĂ©marre la lecture de l'animation. + * + * @param plugin Le plugin gĂ©rant la tĂąche Bukkit. + * @param interval L'intervalle de temps entre chaque frame. + */ + public void startAnimation(Plugin plugin, Duration interval) { + Objects.requireNonNull(plugin, "plugin cannot be null"); + stopAnimation(); + + if (frames.isEmpty()) return; + + long ticks = Math.max(1, (interval != null ? interval.toMillis() : 500) / 50); + + this.animationTask = Bukkit.getScheduler().runTaskTimer(plugin, () -> { + if (getViewers().isEmpty()) { + // Pas de spectateur -> pause temporaire ou stop + return; + } + + advanceFrame(); + }, 0L, ticks); + } + + /** + * Avance d'une frame et met Ă  jour les slots pour tous les spectateurs. + */ + public void advanceFrame() { + if (frames.isEmpty()) return; + + Frame frame = frames.get(currentFrameIndex); + for (Map.Entry entry : frame.getItems().entrySet()) { + super.setItem(entry.getKey(), entry.getValue()); + } + + if (frame.getTitle() != null) { + super.setTitle(frame.getTitle()); + } + + currentFrameIndex++; + if (currentFrameIndex >= frames.size()) { + if (loop) { + currentFrameIndex = 0; + } else { + stopAnimation(); + } + } + } + + /** + * ArrĂȘte l'animation en cours. + */ + public void stopAnimation() { + if (animationTask != null) { + animationTask.cancel(); + animationTask = null; + } + } + + @Override + public void close(Player player) { + super.close(player); + if (getViewers().isEmpty()) { + stopAnimation(); + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/type/PaginatedGui.java b/src/main/java/fr/luc/bettermcguis/type/PaginatedGui.java new file mode 100644 index 0000000..75555c6 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/type/PaginatedGui.java @@ -0,0 +1,348 @@ +package fr.luc.bettermcguis.type; + +import fr.luc.bettermcguis.api.GuiClickAction; +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.builder.ItemBuilder; +import fr.luc.bettermcguis.event.GuiPageChangeEvent; +import fr.luc.bettermcguis.pattern.GuiMask; +import org.bukkit.Material; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; + +import java.util.*; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.function.BiFunction; +import java.util.function.Consumer; + +/** + * ImplĂ©mentation d'un inventaire paginĂ© (Paginated GUI) gĂ©rant automatiquement la navigation par pages, + * le calcul dynamique du nombre de pages, les boutons suivant/prĂ©cĂ©dent et l'affichage d'un indicateur de page. + */ +public class PaginatedGui extends SimpleGui { + + private final List pageItems = new ArrayList<>(); + private final List itemSlots = new ArrayList<>(); + private int currentPage = 1; // 1-indexed pour plus de lisibilitĂ© + + private Integer previousPageSlot; + private Integer nextPageSlot; + private Integer pageIndicatorSlot; + + private GuiItem customPreviousButton; + private GuiItem customNextButton; + private BiFunction pageIndicatorSupplier; + + private final List> pageChangeHooks = new CopyOnWriteArrayList<>(); + + /** + * Initialise un GUI paginĂ© avec un titre et un type d'inventaire. + */ + public PaginatedGui(String title, GuiType type) { + super(title, type); + initDefaultItemSlots(); + } + + /** + * Initialise un GUI paginĂ© avec un nombre de lignes de coffre. + */ + public PaginatedGui(String title, int rows) { + super(title, rows); + initDefaultItemSlots(); + } + + private void initDefaultItemSlots() { + // Par dĂ©faut, si 3 lignes ou plus, on utilise l'intĂ©rieur + if (getRows() >= 3) { + this.itemSlots.addAll(SlotRange.interior(getRows(), getColumns()).getSlots()); + this.previousPageSlot = (getRows() - 1) * getColumns() + 3; // ex: slot 48 + this.pageIndicatorSlot = (getRows() - 1) * getColumns() + 4; // ex: slot 49 + this.nextPageSlot = (getRows() - 1) * getColumns() + 5; // ex: slot 50 + } else { + for (int i = 0; i < getSize() - 2; i++) { + this.itemSlots.add(i); + } + this.previousPageSlot = getSize() - 2; + this.nextPageSlot = getSize() - 1; + } + } + + /** + * Ajoute un item paginĂ© Ă  la collection. + * + * @param item L'item Ă  ajouter. + */ + public void addPageItem(GuiItem item) { + if (item != null) { + this.pageItems.add(item); + } + } + + /** + * Ajoute une collection complĂšte d'items paginĂ©s. + * + * @param items Les items. + */ + public void addPageItems(Collection items) { + if (items != null) { + this.pageItems.addAll(items); + } + } + + /** + * Remplace l'intĂ©gralitĂ© de la collection d'items paginĂ©s. + * + * @param items La nouvelle liste d'items. + */ + public void setPageItems(List items) { + this.pageItems.clear(); + if (items != null) { + this.pageItems.addAll(items); + } + } + + /** + * Supprime tous les items de la collection paginĂ©e. + */ + public void clearPageItems() { + this.pageItems.clear(); + this.currentPage = 1; + } + + /** + * DĂ©finit explicitement la liste des slots rĂ©servĂ©s pour les items paginĂ©s. + * + * @param slots Les numĂ©ros de slots. + */ + public void setItemSlots(List slots) { + this.itemSlots.clear(); + if (slots != null) { + this.itemSlots.addAll(slots); + } + } + + /** + * DĂ©finit les slots d'items Ă  partir d'une plage {@link SlotRange}. + */ + public void setItemSlots(SlotRange range) { + if (range != null) { + setItemSlots(range.getSlots()); + } + } + + /** + * DĂ©finit les slots d'items Ă  partir d'un masque binaire {@link GuiMask}. + */ + public void setItemSlots(GuiMask mask) { + if (mask != null) { + setItemSlots(mask.resolveSlots(getRows(), getColumns())); + } + } + + /** + * Configure le bouton de page prĂ©cĂ©dente. + * + * @param slot Le numĂ©ro de slot. + * @param item L'item du bouton (ou null pour le bouton par dĂ©faut). + */ + public void setPreviousPageButton(int slot, GuiItem item) { + this.previousPageSlot = slot; + this.customPreviousButton = item; + } + + /** + * Configure le bouton de page suivante. + * + * @param slot Le numĂ©ro de slot. + * @param item L'item du bouton (ou null pour le bouton par dĂ©faut). + */ + public void setNextPageButton(int slot, GuiItem item) { + this.nextPageSlot = slot; + this.customNextButton = item; + } + + /** + * Configure l'indicateur de page (ex: "Page 2/5"). + * + * @param slot Le numĂ©ro de slot. + * @param indicatorSupplier Fonction fournissant l'item selon (pageActuelle, pageMax). + */ + public void setPageIndicator(int slot, BiFunction indicatorSupplier) { + this.pageIndicatorSlot = slot; + this.pageIndicatorSupplier = indicatorSupplier; + } + + /** + * @return Le nombre d'items pouvant ĂȘtre affichĂ©s par page. + */ + public int getPageSize() { + return Math.max(1, itemSlots.size()); + } + + /** + * @return Le nombre total de pages nĂ©cessaires pour afficher tous les items (au minimum 1). + */ + public int getTotalPages() { + if (pageItems.isEmpty()) { + return 1; + } + return (int) Math.ceil((double) pageItems.size() / getPageSize()); + } + + /** + * @return Le numĂ©ro de la page actuelle (1-indexĂ©). + */ + public int getCurrentPage() { + return currentPage; + } + + /** + * DĂ©finit la page actuelle en effectuant les vĂ©rifications de bornes et dĂ©clenchant l'Ă©vĂ©nement. + * + * @param page Le numĂ©ro de page (1 Ă  totalPages). + * @return true si la page a changĂ©, sinon false. + */ + public boolean setCurrentPage(int page) { + int max = getTotalPages(); + int target = Math.max(1, Math.min(max, page)); + if (target == this.currentPage) { + return false; + } + + int oldPage = this.currentPage; + this.currentPage = target; + + GuiPageChangeEvent event = new GuiPageChangeEvent(this, null, oldPage, target); + for (Consumer hook : pageChangeHooks) { + try { + hook.accept(event); + } catch (Exception e) { + e.printStackTrace(); + } + } + + refreshAll(); + return true; + } + + /** + * @return true si une page suivante existe aprĂšs la page actuelle. + */ + public boolean hasNextPage() { + return currentPage < getTotalPages(); + } + + /** + * @return true si une page prĂ©cĂ©dente existe avant la page actuelle. + */ + public boolean hasPreviousPage() { + return currentPage > 1; + } + + /** + * Passe Ă  la page suivante si possible. + * + * @return true si la navigation a rĂ©ussi. + */ + public boolean nextPage() { + if (hasNextPage()) { + return setCurrentPage(currentPage + 1); + } + return false; + } + + /** + * Revient Ă  la page prĂ©cĂ©dente si possible. + * + * @return true si la navigation a rĂ©ussi. + */ + public boolean previousPage() { + if (hasPreviousPage()) { + return setCurrentPage(currentPage - 1); + } + return false; + } + + /** + * Attache un Ă©couteur appelĂ© lors d'un changement de page. + * + * @param hook L'action Ă  exĂ©cuter. + * @return Ce GUI pour chaĂźnage. + */ + public PaginatedGui onPageChange(Consumer hook) { + if (hook != null) { + this.pageChangeHooks.add(hook); + } + return this; + } + + @Override + public Inventory createInventory(Player player) { + populatePageElements(); + return super.createInventory(player); + } + + @Override + public void refresh(Player player) { + populatePageElements(); + super.refresh(player); + } + + private void populatePageElements() { + // 1. Nettoie les slots d'items paginĂ©s + for (int slot : itemSlots) { + super.removeItem(slot); + } + + // 2. Remplit les items pour la page actuelle + int pageSize = getPageSize(); + int startIndex = (currentPage - 1) * pageSize; + int endIndex = Math.min(startIndex + pageSize, pageItems.size()); + + for (int i = 0; i < (endIndex - startIndex); i++) { + int slot = itemSlots.get(i); + GuiItem item = pageItems.get(startIndex + i); + super.setItem(slot, item); + } + + // 3. Bouton Page PrĂ©cĂ©dente + if (previousPageSlot != null) { + if (hasPreviousPage()) { + GuiItem prevBtn = (customPreviousButton != null) ? customPreviousButton : + ItemBuilder.of(Material.ARROW) + .name("◀ Page PrĂ©cĂ©dente") + .lore("Aller Ă  la page " + (currentPage - 1) + "") + .asGuiItem(ctx -> previousPage()); + super.setItem(previousPageSlot, prevBtn); + } else { + super.removeItem(previousPageSlot); + } + } + + // 4. Bouton Page Suivante + if (nextPageSlot != null) { + if (hasNextPage()) { + GuiItem nextBtn = (customNextButton != null) ? customNextButton : + ItemBuilder.of(Material.ARROW) + .name("Page Suivante ▶") + .lore("Aller Ă  la page " + (currentPage + 1) + "") + .asGuiItem(ctx -> nextPage()); + super.setItem(nextPageSlot, nextBtn); + } else { + super.removeItem(nextPageSlot); + } + } + + // 5. Indicateur de Page + if (pageIndicatorSlot != null) { + int total = getTotalPages(); + GuiItem indicator = (pageIndicatorSupplier != null) ? pageIndicatorSupplier.apply(currentPage, total) : + ItemBuilder.of(Material.PAPER) + .name("Page " + currentPage + " / " + total + "") + .lore("Total d'Ă©lĂ©ments : " + pageItems.size() + "") + .asGuiItem(); + super.setItem(pageIndicatorSlot, indicator); + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/type/SimpleGui.java b/src/main/java/fr/luc/bettermcguis/type/SimpleGui.java new file mode 100644 index 0000000..adc7aeb --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/type/SimpleGui.java @@ -0,0 +1,382 @@ +package fr.luc.bettermcguis.type; + +import fr.luc.bettermcguis.api.*; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.holder.BetterGuiHolder; +import fr.luc.bettermcguis.pattern.GuiPattern; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.minimessage.MiniMessage; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; +import org.bukkit.inventory.ItemStack; + +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.concurrent.CopyOnWriteArraySet; +import java.util.function.Consumer; + +/** + * ImplĂ©mentation standard et autonome d'un menu d'inventaire interactif (GUI). + */ +public class SimpleGui implements Gui { + + protected String title; + protected Component titleComponent; + protected final GuiType type; + protected final Map items = new ConcurrentHashMap<>(); + protected final Set editableSlots = new CopyOnWriteArraySet<>(); + protected final Map properties = new ConcurrentHashMap<>(); + protected final Set viewers = new CopyOnWriteArraySet<>(); + + // Hooks du cycle de vie + protected final List> openHooks = new CopyOnWriteArrayList<>(); + protected final List> closeHooks = new CopyOnWriteArrayList<>(); + protected final List> clickHooks = new CopyOnWriteArrayList<>(); + protected final List> outsideClickHooks = new CopyOnWriteArrayList<>(); + protected final List> bottomClickHooks = new CopyOnWriteArrayList<>(); + + /** + * Initialise un GUI avec un titre et un type d'inventaire. + * + * @param title Le titre au format MiniMessage. + * @param type Le type de l'inventaire. + */ + public SimpleGui(String title, GuiType type) { + this.type = Objects.requireNonNull(type, "GuiType cannot be null"); + setTitle(title != null ? title : "Menu"); + } + + /** + * Initialise un GUI avec un nombre de lignes de coffre (1 Ă  6). + * + * @param title Le titre au format MiniMessage. + * @param rows Le nombre de lignes (1 Ă  6). + */ + public SimpleGui(String title, int rows) { + this(title, GuiType.chest(rows)); + } + + @Override + public String getTitle() { + return title; + } + + @Override + public Component getTitleComponent() { + return titleComponent; + } + + @Override + public void setTitle(String miniMessage) { + this.title = miniMessage != null ? miniMessage : ""; + this.titleComponent = MiniMessage.miniMessage().deserialize(this.title); + } + + @Override + public GuiType getType() { + return type; + } + + @Override + public void setItem(int slot, GuiItem item) { + if (slot < 0 || slot >= getSize()) { + return; + } + if (item == null) { + items.remove(slot); + } else { + items.put(slot, item); + } + + // Met Ă  jour visuellement les inventaires ouverts pour les visualisateurs + for (Player viewer : getViewers()) { + if (viewer.getOpenInventory().getTopInventory().getHolder() instanceof BetterGuiHolder holder + && holder.getGui() == this) { + Inventory top = viewer.getOpenInventory().getTopInventory(); + ItemStack stack = (item != null && item.isVisibleFor(viewer)) ? item.getItemStack() : null; + top.setItem(slot, stack); + } + } + } + + @Override + public GuiItem getItem(int slot) { + return items.get(slot); + } + + @Override + public void removeItem(int slot) { + setItem(slot, null); + } + + @Override + public void clear() { + items.clear(); + for (Player viewer : getViewers()) { + refresh(viewer); + } + } + + @Override + public void fill(GuiItem item) { + for (int i = 0; i < getSize(); i++) { + setItem(i, item); + } + } + + @Override + public void fillBorder(GuiItem item) { + fillRange(SlotRange.border(getRows(), getColumns()), item); + } + + @Override + public void fillRange(SlotRange range, GuiItem item) { + if (range != null) { + for (int slot : range.getSlots()) { + setItem(slot, item); + } + } + } + + @Override + public void applyPattern(GuiPattern pattern) { + if (pattern != null) { + pattern.apply(this); + } + } + + @Override + public void open(Player player) { + Objects.requireNonNull(player, "player cannot be null"); + Inventory inventory = createInventory(player); + + GuiOpenContext openContext = new GuiOpenContext(player, this, null); + handleOpen(openContext); + + if (!openContext.isCancelled()) { + player.openInventory(inventory); + viewers.add(player.getUniqueId()); + } + } + + @Override + public void close(Player player) { + if (player != null) { + viewers.remove(player.getUniqueId()); + player.closeInventory(); + } + } + + @Override + public void refresh(Player player) { + if (player == null || !player.isOnline()) return; + + if (player.getOpenInventory().getTopInventory().getHolder() instanceof BetterGuiHolder holder + && holder.getGui() == this) { + Inventory inv = player.getOpenInventory().getTopInventory(); + for (int i = 0; i < getSize(); i++) { + if (editableSlots.contains(i)) { + continue; + } + GuiItem item = items.get(i); + if (item != null && item.isVisibleFor(player)) { + inv.setItem(i, item.getItemStack()); + } else { + inv.setItem(i, null); + } + } + player.updateInventory(); + } + } + + @Override + public void refreshAll() { + for (Player viewer : getViewers()) { + refresh(viewer); + } + } + + @Override + public Set getViewers() { + Set playerSet = new HashSet<>(); + for (UUID uuid : viewers) { + Player p = Bukkit.getPlayer(uuid); + if (p != null && p.isOnline()) { + playerSet.add(p); + } else { + viewers.remove(uuid); + } + } + return Collections.unmodifiableSet(playerSet); + } + + @Override + public Inventory createInventory(Player player) { + BetterGuiHolder holder = new BetterGuiHolder(this, player); + Inventory inventory; + + if (type.getBukkitType() == org.bukkit.event.inventory.InventoryType.CHEST) { + inventory = Bukkit.createInventory(holder, getSize(), titleComponent); + } else { + inventory = Bukkit.createInventory(holder, type.getBukkitType(), titleComponent); + } + + holder.setInventory(inventory); + + // Place les items + for (Map.Entry entry : items.entrySet()) { + int slot = entry.getKey(); + GuiItem item = entry.getValue(); + if (slot >= 0 && slot < getSize() && item != null) { + if (player == null || item.isVisibleFor(player)) { + inventory.setItem(slot, item.getItemStack()); + } + } + } + + return inventory; + } + + @Override + public void setEditable(int slot, boolean editable) { + if (editable) { + editableSlots.add(slot); + } else { + editableSlots.remove(slot); + } + } + + @Override + public boolean isEditable(int slot) { + return editableSlots.contains(slot); + } + + @Override + public Set getEditableSlots() { + return Collections.unmodifiableSet(editableSlots); + } + + @Override + public void setProperty(String key, Object value) { + if (value == null) { + properties.remove(key); + } else { + properties.put(key, value); + } + } + + @SuppressWarnings("unchecked") + @Override + public T getProperty(String key, Class type) { + Object val = properties.get(key); + if (val != null && type.isInstance(val)) { + return (T) val; + } + return null; + } + + @SuppressWarnings("unchecked") + @Override + public T getProperty(String key, T defaultValue) { + Object val = properties.get(key); + if (val != null && defaultValue != null && defaultValue.getClass().isInstance(val)) { + return (T) val; + } + return defaultValue; + } + + @Override + public Map getProperties() { + return Collections.unmodifiableMap(properties); + } + + @Override + public Gui onOpen(Consumer hook) { + this.openHooks.add(Objects.requireNonNull(hook, "hook cannot be null")); + return this; + } + + @Override + public Gui onClose(Consumer hook) { + this.closeHooks.add(Objects.requireNonNull(hook, "hook cannot be null")); + return this; + } + + @Override + public Gui onClick(Consumer hook) { + this.clickHooks.add(Objects.requireNonNull(hook, "hook cannot be null")); + return this; + } + + @Override + public Gui onOutsideClick(Consumer hook) { + this.outsideClickHooks.add(Objects.requireNonNull(hook, "hook cannot be null")); + return this; + } + + @Override + public Gui onBottomClick(Consumer hook) { + this.bottomClickHooks.add(Objects.requireNonNull(hook, "hook cannot be null")); + return this; + } + + @Override + public void handleOpen(GuiOpenContext context) { + for (Consumer hook : openHooks) { + try { + hook.accept(context); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + @Override + public void handleClose(GuiCloseContext context) { + if (context.getPlayer() != null) { + viewers.remove(context.getPlayer().getUniqueId()); + } + for (Consumer hook : closeHooks) { + try { + hook.accept(context); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + @Override + public void handleClick(GuiClickContext context) { + for (Consumer hook : clickHooks) { + try { + hook.accept(context); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + @Override + public void handleOutsideClick(GuiClickContext context) { + for (Consumer hook : outsideClickHooks) { + try { + hook.accept(context); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + @Override + public void handleBottomClick(GuiClickContext context) { + for (Consumer hook : bottomClickHooks) { + try { + hook.accept(context); + } catch (Exception e) { + e.printStackTrace(); + } + } + } +} diff --git a/src/main/java/fr/luc/bettermcguis/type/StorageGui.java b/src/main/java/fr/luc/bettermcguis/type/StorageGui.java new file mode 100644 index 0000000..d09b868 --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/type/StorageGui.java @@ -0,0 +1,106 @@ +package fr.luc.bettermcguis.type; + +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotRange; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; +import org.bukkit.inventory.ItemStack; + +import java.util.*; +import java.util.function.BiConsumer; + +/** + * ImplĂ©mentation d'un GUI de stockage / zone de dĂ©pĂŽt (Storage GUI). + * Permet aux joueurs de dĂ©poser, retirer ou modifier librement des items dans des slots spĂ©cifiĂ©s (ex: poubelle, coffre d'Ă©change, enclume). + */ +public class StorageGui extends SimpleGui { + + private final Set storageSlots = new HashSet<>(); + private BiConsumer itemDepositHook; + private BiConsumer itemWithdrawHook; + private boolean returnItemsOnClose = true; + + public StorageGui(String title, GuiType type) { + super(title, type); + } + + public StorageGui(String title, int rows) { + super(title, rows); + } + + /** + * DĂ©finit les slots utilisables comme zone de stockage modifiable. + * + * @param slots Les slots Ă©ditables. + * @return Ce GUI pour chaĂźnage. + */ + public StorageGui setStorageSlots(Collection slots) { + if (slots != null) { + for (int s : slots) { + this.storageSlots.add(s); + super.setEditable(s, true); + } + } + return this; + } + + /** + * DĂ©finit les slots de stockage via une plage {@link SlotRange}. + */ + public StorageGui setStorageSlots(SlotRange range) { + if (range != null) { + setStorageSlots(range.getSlots()); + } + return this; + } + + /** + * DĂ©finit si les items laissĂ©s dans la zone de stockage doivent ĂȘtre restituĂ©s au joueur lors de la fermeture. + * + * @param returnItems true pour restituer dans l'inventaire du joueur (ou au sol si plein). + */ + public StorageGui returnItemsOnClose(boolean returnItems) { + this.returnItemsOnClose = returnItems; + return this; + } + + /** + * RĂ©cupĂšre tous les items actuellement prĂ©sents dans les slots de stockage. + * + * @param inventory L'inventaire Bukkit ouvert. + * @return La liste des {@link ItemStack} prĂ©sents. + */ + public List getStoredItems(Inventory inventory) { + List list = new ArrayList<>(); + if (inventory != null) { + for (int slot : storageSlots) { + ItemStack item = inventory.getItem(slot); + if (item != null && !item.getType().isAir()) { + list.add(item); + } + } + } + return list; + } + + @Override + public void handleClose(fr.luc.bettermcguis.api.GuiCloseContext context) { + Player player = context.getPlayer(); + Inventory inv = context.getRawEvent() != null ? context.getRawEvent().getInventory() : null; + + if (returnItemsOnClose && player != null && inv != null) { + for (int slot : storageSlots) { + ItemStack item = inv.getItem(slot); + if (item != null && !item.getType().isAir()) { + HashMap leftover = player.getInventory().addItem(item); + for (ItemStack drop : leftover.values()) { + player.getWorld().dropItemNaturally(player.getLocation(), drop); + } + inv.setItem(slot, null); + } + } + } + + super.handleClose(context); + } +} diff --git a/src/main/java/fr/luc/bettermcguis/type/TabbedGui.java b/src/main/java/fr/luc/bettermcguis/type/TabbedGui.java new file mode 100644 index 0000000..82c08ca --- /dev/null +++ b/src/main/java/fr/luc/bettermcguis/type/TabbedGui.java @@ -0,0 +1,144 @@ +package fr.luc.bettermcguis.type; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.pattern.GuiPattern; +import org.bukkit.entity.Player; +import org.bukkit.inventory.Inventory; + +import java.util.*; + +/** + * ImplĂ©mentation d'un menu Ă  onglets (Tabbed GUI) permettant de basculer instantanĂ©ment + * entre plusieurs vues / catĂ©gories sans avoir Ă  fermer ou rouvrir l'inventaire du joueur. + */ +public class TabbedGui extends SimpleGui { + + private final Map> tabItems = new LinkedHashMap<>(); + private final Map tabButtonSlots = new LinkedHashMap<>(); + private final Map tabButtonItems = new LinkedHashMap<>(); + private String activeTabId; + + /** + * Initialise un GUI Ă  onglets. + */ + public TabbedGui(String title, GuiType type) { + super(title, type); + } + + /** + * Initialise un GUI Ă  onglets avec un nombre de lignes de coffre. + */ + public TabbedGui(String title, int rows) { + super(title, rows); + } + + /** + * Enregistre un nouvel onglet avec son bouton d'accĂšs. + * + * @param tabId L'identifiant unique de l'onglet (ex: "shop", "quetes", "profil"). + * @param buttonSlot Le slot sur lequel sera placĂ© le bouton de navigation. + * @param buttonItem L'item du bouton reprĂ©sentant l'onglet. + * @return Cette instance de {@link TabbedGui} pour chaĂźnage. + */ + public TabbedGui addTab(String tabId, int buttonSlot, GuiItem buttonItem) { + Objects.requireNonNull(tabId, "tabId cannot be null"); + this.tabItems.putIfAbsent(tabId, new HashMap<>()); + if (buttonSlot >= 0) { + this.tabButtonSlots.put(tabId, buttonSlot); + this.tabButtonItems.put(tabId, buttonItem); + + // Attache l'action de sĂ©lection d'onglet + GuiItem itemWithAction = (buttonItem != null) ? buttonItem : GuiItem.empty(); + super.setItem(buttonSlot, itemWithAction.onClick(ctx -> selectTab(tabId))); + } + if (this.activeTabId == null) { + this.activeTabId = tabId; + } + return this; + } + + /** + * DĂ©finit un item pour un onglet spĂ©cifique. + * + * @param tabId L'identifiant de l'onglet. + * @param slot Le slot cible. + * @param item L'item Ă  placer. + */ + public void setTabItem(String tabId, int slot, GuiItem item) { + Map map = tabItems.computeIfAbsent(tabId, k -> new HashMap<>()); + if (item == null) { + map.remove(slot); + } else { + map.put(slot, item); + } + if (tabId.equalsIgnoreCase(activeTabId)) { + super.setItem(slot, item); + } + } + + /** + * Applique un motif ASCII pour un onglet spĂ©cifique. + * + * @param tabId L'identifiant de l'onglet. + * @param pattern Le motif. + */ + public void applyTabPattern(String tabId, GuiPattern pattern) { + if (pattern != null) { + int cols = getColumns(); + int maxRows = getRows(); + List rows = pattern.getRows(); + Map bindings = pattern.getItemBindings(); + + for (int r = 0; r < Math.min(rows.size(), maxRows); r++) { + String line = rows.get(r); + for (int c = 0; c < Math.min(line.length(), cols); c++) { + char ch = line.charAt(c); + if (bindings.containsKey(ch)) { + setTabItem(tabId, r * cols + c, bindings.get(ch)); + } + } + } + } + } + + /** + * SĂ©lectionne et affiche l'onglet demandĂ© pour tous les visualisateurs. + * + * @param tabId L'identifiant de l'onglet Ă  afficher. + * @return true si l'onglet existe et a Ă©tĂ© sĂ©lectionnĂ©. + */ + public boolean selectTab(String tabId) { + if (!tabItems.containsKey(tabId) || tabId.equalsIgnoreCase(activeTabId)) { + return false; + } + + this.activeTabId = tabId; + applyActiveTabItems(); + refreshAll(); + return true; + } + + /** + * @return L'identifiant de l'onglet actuellement affichĂ©. + */ + public String getActiveTabId() { + return activeTabId; + } + + private void applyActiveTabItems() { + if (activeTabId == null) return; + Map currentItems = tabItems.get(activeTabId); + if (currentItems != null) { + for (Map.Entry entry : currentItems.entrySet()) { + super.setItem(entry.getKey(), entry.getValue()); + } + } + } + + @Override + public Inventory createInventory(Player player) { + applyActiveTabItems(); + return super.createInventory(player); + } +} diff --git a/src/test/java/fr/luc/bettermcguis/GuiLayoutAndPatternTest.java b/src/test/java/fr/luc/bettermcguis/GuiLayoutAndPatternTest.java new file mode 100644 index 0000000..5713ba1 --- /dev/null +++ b/src/test/java/fr/luc/bettermcguis/GuiLayoutAndPatternTest.java @@ -0,0 +1,104 @@ +package fr.luc.bettermcguis; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotPos; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.pattern.GuiMask; +import fr.luc.bettermcguis.pattern.GuiPattern; +import fr.luc.bettermcguis.type.SimpleGui; +import org.bukkit.Material; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.util.List; + +import static org.junit.jupiter.api.Assertions.*; + +public class GuiLayoutAndPatternTest { + + @Test + @DisplayName("SlotPos doit convertir correctement (row, col) en slot absolu et inversement") + void testSlotPosConversions() { + SlotPos pos = SlotPos.of(1, 4); // Ligne 1, Col 4 dans un coffre de 9 cols -> slot 13 + assertEquals(13, pos.toSlot(9)); + + SlotPos fromSlot = SlotPos.fromSlot(13, 9); + assertEquals(1, fromSlot.getRow()); + assertEquals(4, fromSlot.getColumn()); + } + + @Test + @DisplayName("SlotRange.border doit calculer les bordures exactes d'un coffre 3 lignes") + void testSlotRangeBorder() { + SlotRange border = SlotRange.border(3, 9); + List slots = border.getSlots(); + + // Total slots = 27. Bordures = 9 (ligne 0) + 9 (ligne 2) + 2 (col 0 et col 8 de ligne 1) = 20 + assertEquals(20, slots.size()); + assertTrue(slots.contains(0)); + assertTrue(slots.contains(8)); + assertTrue(slots.contains(9)); + assertTrue(slots.contains(17)); + assertTrue(slots.contains(18)); + assertTrue(slots.contains(26)); + assertFalse(slots.contains(13)); // Le centre (1, 4) n'est pas une bordure + } + + @Test + @DisplayName("SlotRange.interior doit calculer l'intĂ©rieur d'un coffre 3 lignes") + void testSlotRangeInterior() { + SlotRange interior = SlotRange.interior(3, 9); + List slots = interior.getSlots(); + + // 7 slots intĂ©rieurs (10 Ă  16) + assertEquals(7, slots.size()); + assertTrue(slots.contains(10)); + assertTrue(slots.contains(13)); + assertTrue(slots.contains(16)); + assertFalse(slots.contains(9)); + assertFalse(slots.contains(17)); + } + + @Test + @DisplayName("GuiPattern doit appliquer les items selon les caractĂšres de la matrice") + void testGuiPatternApplication() { + SimpleGui gui = new SimpleGui("Pattern Test", GuiType.CHEST_3_ROWS); + + GuiItem glass = GuiItem.of(Material.BLACK_STAINED_GLASS_PANE); + GuiItem diamond = GuiItem.of(Material.DIAMOND); + + GuiPattern pattern = GuiPattern.of( + "#########", + "# D #", + "#########" + ) + .bind('#', glass) + .bind('D', diamond); + + gui.applyPattern(pattern); + + assertEquals(glass, gui.getItem(0)); + assertEquals(glass, gui.getItem(8)); + assertEquals(diamond, gui.getItem(13)); // Ligne 1, Col 4 + assertNull(gui.getItem(10)); // Emplacement vide ' ' + } + + @Test + @DisplayName("GuiMask doit rĂ©soudre les slots actifs marquĂ©s par '1'") + void testGuiMaskResolution() { + GuiMask mask = new GuiMask( + "100000001", + "000010000", + "100000001" + ); + + List activeSlots = mask.resolveSlots(3, 9); + assertEquals(5, activeSlots.size()); + assertTrue(activeSlots.contains(0)); + assertTrue(activeSlots.contains(8)); + assertTrue(activeSlots.contains(13)); + assertTrue(activeSlots.contains(18)); + assertTrue(activeSlots.contains(26)); + } +} diff --git a/src/test/java/fr/luc/bettermcguis/GuiLifecycleAndEventTest.java b/src/test/java/fr/luc/bettermcguis/GuiLifecycleAndEventTest.java new file mode 100644 index 0000000..3b84929 --- /dev/null +++ b/src/test/java/fr/luc/bettermcguis/GuiLifecycleAndEventTest.java @@ -0,0 +1,79 @@ +package fr.luc.bettermcguis; + +import fr.luc.bettermcguis.api.GuiClickContext; +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.event.GuiClickEvent; +import fr.luc.bettermcguis.event.GuiEventManager; +import fr.luc.bettermcguis.event.annotation.GuiEventHandler; +import fr.luc.bettermcguis.type.SimpleGui; +import org.bukkit.Material; +import org.bukkit.entity.Player; +import org.bukkit.event.inventory.ClickType; +import org.bukkit.event.inventory.InventoryAction; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.junit.jupiter.api.Assertions.*; + +public class GuiLifecycleAndEventTest { + + @Test + @DisplayName("GuiItem doit exĂ©cuter son callback de clic et annuler l'action par dĂ©faut") + void testGuiItemClickHandling() { + AtomicBoolean itemActionRan = new AtomicBoolean(false); + + GuiItem item = GuiItem.of(Material.COMPASS) + .onClick(ctx -> itemActionRan.set(true)); + + Player player = Mockito.mock(Player.class); + SimpleGui gui = new SimpleGui("Test", GuiType.CHEST_1_ROW); + + GuiClickContext ctx = new GuiClickContext( + player, gui, item, 4, null, + ClickType.LEFT, InventoryAction.PICKUP_ALL, + null, null, null + ); + + item.handleClick(ctx); + + assertTrue(itemActionRan.get()); + assertTrue(ctx.isCancelled()); // AnnulĂ© par dĂ©faut + } + + @Test + @DisplayName("GuiEventManager doit trier les Ă©couteurs par prioritĂ© et distribuer les Ă©vĂ©nements") + void testEventManagerPriorityAndDispatch() { + GuiEventManager eventManager = new GuiEventManager(); + List executionOrder = new ArrayList<>(); + + Object listener = new Object() { + @GuiEventHandler(priority = 5) + public void onLowPriorityClick(GuiClickEvent event) { + executionOrder.add("low"); + } + + @GuiEventHandler(priority = 100) + public void onHighPriorityClick(GuiClickEvent event) { + executionOrder.add("high"); + } + }; + + eventManager.registerListeners(listener); + + Player player = Mockito.mock(Player.class); + SimpleGui gui = new SimpleGui("Priority Test", GuiType.CHEST_1_ROW); + GuiClickContext ctx = new GuiClickContext(player, gui, null, 0, null, ClickType.LEFT, InventoryAction.NOTHING, null, null, null); + + eventManager.dispatch(new GuiClickEvent(ctx)); + + assertEquals(2, executionOrder.size()); + assertEquals("high", executionOrder.get(0)); + assertEquals("low", executionOrder.get(1)); + } +} diff --git a/src/test/java/fr/luc/bettermcguis/ItemBuilderTest.java b/src/test/java/fr/luc/bettermcguis/ItemBuilderTest.java new file mode 100644 index 0000000..b150491 --- /dev/null +++ b/src/test/java/fr/luc/bettermcguis/ItemBuilderTest.java @@ -0,0 +1,48 @@ +package fr.luc.bettermcguis; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.builder.ItemBuilder; +import org.bukkit.Material; +import org.bukkit.inventory.ItemStack; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.*; + +public class ItemBuilderTest { + + @Test + @DisplayName("ItemBuilder doit crĂ©er un ItemStack valide avec quantitĂ© et matĂ©riau") + void testBasicItemCreation() { + ItemStack item = ItemBuilder.of(Material.DIAMOND) + .amount(16) + .build(); + + assertNotNull(item); + assertEquals(Material.DIAMOND, item.getType()); + assertEquals(16, item.getAmount()); + } + + @Test + @DisplayName("ItemBuilder doit se convertir en GuiItem interactif") + void testAsGuiItem() { + boolean[] clicked = new boolean[]{false}; + + GuiItem guiItem = ItemBuilder.of(Material.EMERALD) + .name("Test") + .asGuiItem(ctx -> clicked[0] = true); + + assertNotNull(guiItem); + assertEquals(Material.EMERALD, guiItem.getItemStack().getType()); + assertNotNull(guiItem.getClickAction()); + } + + @Test + @DisplayName("ItemBuilder.filler doit crĂ©er un item avec un nom vide") + void testFillerItem() { + ItemBuilder builder = ItemBuilder.filler(Material.BLACK_STAINED_GLASS_PANE); + assertNotNull(builder); + ItemStack stack = builder.build(); + assertEquals(Material.BLACK_STAINED_GLASS_PANE, stack.getType()); + } +} diff --git a/src/test/java/fr/luc/bettermcguis/PaginatedGuiTest.java b/src/test/java/fr/luc/bettermcguis/PaginatedGuiTest.java new file mode 100644 index 0000000..5ceefb7 --- /dev/null +++ b/src/test/java/fr/luc/bettermcguis/PaginatedGuiTest.java @@ -0,0 +1,69 @@ +package fr.luc.bettermcguis; + +import fr.luc.bettermcguis.api.GuiItem; +import fr.luc.bettermcguis.api.GuiType; +import fr.luc.bettermcguis.api.slot.SlotRange; +import fr.luc.bettermcguis.type.PaginatedGui; +import org.bukkit.Material; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.util.concurrent.atomic.AtomicInteger; + +import static org.junit.jupiter.api.Assertions.*; + +public class PaginatedGuiTest { + + @Test + @DisplayName("PaginatedGui doit calculer correctement le nombre total de pages") + void testPaginationMath() { + PaginatedGui gui = new PaginatedGui("Paginated Test", GuiType.CHEST_3_ROWS); + gui.setItemSlots(SlotRange.of(10, 16)); // 7 slots par page + + assertEquals(7, gui.getPageSize()); + assertEquals(1, gui.getTotalPages()); // 0 items -> 1 page vide + + for (int i = 0; i < 20; i++) { + gui.addPageItem(GuiItem.of(Material.GOLD_INGOT)); + } + + // 20 items / 7 par page -> 3 pages (7 + 7 + 6) + assertEquals(3, gui.getTotalPages()); + assertEquals(1, gui.getCurrentPage()); + assertTrue(gui.hasNextPage()); + assertFalse(gui.hasPreviousPage()); + } + + @Test + @DisplayName("PaginatedGui doit naviguer entre les pages et dĂ©clencher l'Ă©vĂ©nement") + void testPageNavigationAndEvents() { + PaginatedGui gui = new PaginatedGui("Paginated Test", GuiType.CHEST_3_ROWS); + gui.setItemSlots(SlotRange.of(10, 16)); + + for (int i = 0; i < 20; i++) { + gui.addPageItem(GuiItem.of(Material.EMERALD)); + } + + AtomicInteger eventFired = new AtomicInteger(0); + gui.onPageChange(evt -> { + eventFired.incrementAndGet(); + assertEquals(1, evt.getOldPage()); + assertEquals(2, evt.getNewPage()); + }); + + assertTrue(gui.nextPage()); + assertEquals(2, gui.getCurrentPage()); + assertEquals(1, eventFired.get()); + + assertTrue(gui.hasPreviousPage()); + assertTrue(gui.hasNextPage()); + + assertTrue(gui.nextPage()); + assertEquals(3, gui.getCurrentPage()); + assertFalse(gui.hasNextPage()); // Fin du catalogue + + // Impossible d'avancer plus loin + assertFalse(gui.nextPage()); + assertEquals(3, gui.getCurrentPage()); + } +}