InventoryListener

​

Packet Types

• PacketType.Play.Server.OPEN_WINDOW - Sent when an inventory GUI is opened (for title formatting)
• PacketType.Play.Server.WINDOW_ITEMS - Sent when inventory contents are updated (for item formatting)

​

Configuration

listeners:
  inventory:
    titles: true  # Format inventory window titles
    items: true   # Format items in inventories

​

Class Structure

public class InventoryListener extends AbstractListener {

    public InventoryListener(ProcessHandler processHandler, ConfigManager configManager) {
        super(processHandler, configManager);
    }

    @Override
    public void onPacketPlaySend(PacketPlaySendEvent e) {
        // Implementation
    }
}

​

Implementation Details

​

1. Packet Type Validation

PacketTypeCommon type = e.getPacketType();
if (type != PacketType.Play.Server.OPEN_WINDOW &&
    type != PacketType.Play.Server.WINDOW_ITEMS) return;

​

2. Configuration Checks

Player player = e.getPlayer();
boolean titles = config.getOrDefault("listeners.inventory.titles", true);
boolean items = config.getOrDefault("listeners.inventory.items", true);

​

3. Inventory Title Processing

if (titles && type == PacketType.Play.Server.OPEN_WINDOW) {
    WrapperPlayServerOpenWindow packet = new WrapperPlayServerOpenWindow(e);
    packet.setTitle(handler.processComponent(packet.getTitle(), player));
}

1. Checks if title formatting is enabled
2. Wraps the packet in WrapperPlayServerOpenWindow
3. Processes the title component through ProcessHandler
4. Updates the packet with the formatted title

​

4. Inventory Items Processing

else if (items && type == PacketType.Play.Server.WINDOW_ITEMS) {
    WrapperPlayServerWindowItems packet = new WrapperPlayServerWindowItems(e);
    packet.setItems(handler.processItems(packet.getItems(), player));
}

1. Checks if item formatting is enabled
2. Wraps the packet in WrapperPlayServerWindowItems
3. Processes all items through ProcessHandler.processItems()
4. Updates the packet with the formatted items

​

Usage Examples

​

Custom GUI Title

Inventory inv = Bukkit.createInventory(null, 27, "<gradient:blue:purple>Shop Menu</gradient>");
player.openInventory(inv);

1. Intercept the OPEN_WINDOW packet
2. Parse the MiniMessage gradient formatting
3. Display “Shop Menu” with a blue-to-purple gradient

​

Item Display Names

ItemStack item = new ItemStack(Material.DIAMOND_SWORD);
ItemMeta meta = item.getItemMeta();
meta.displayName(Component.text("<rainbow>Legendary Sword</rainbow>"));
meta.lore(List.of(
    Component.text("Damage: %player_strength%"),
    Component.text("<italic:false><gray>Epic Weapon")
));
item.setItemMeta(meta);

1. Intercept the WINDOW_ITEMS packet
2. Process the rainbow formatting in the display name
3. Resolve the %player_strength% placeholder in the lore
4. Apply the italic formatting to the description

​

Processing Flow

​

Per-Player Item Data

meta.lore(List.of(
    Component.text("Owner: %player_name%"),
    Component.text("Value: $%player_balance%")
));

​

Dependencies

• PacketEvents: For packet interception
• WrapperPlayServerOpenWindow: Packet wrapper for inventory opening
• WrapperPlayServerWindowItems: Packet wrapper for inventory contents
• ProcessHandler: For placeholder resolution and formatting
  • processComponent() - For inventory titles
  • processItems() - For item collections

​

Related Components

• ItemListener - Handles individual item slot updates
• ProcessHandler - Handles text and item processing
• ConfigManager - Manages listener configuration

​

Common Use Cases

1. Custom Shop Menus
   • Formatted shop titles with gradients
   • Item prices with placeholders
   • Dynamic item descriptions
2. Player Statistics GUIs
   • Personalized stat displays
   • Real-time data in lore
   • Formatted category headers
3. Quest/Achievement Menus
   • Colorful quest titles
   • Progress indicators in lore
   • Reward previews
4. Administrative Panels
   • Formatted control panel titles
   • Option descriptions with player data
   • Status indicators