Register Custom Enchant

Custom Enchantment Registration Guide

This guide explains how to create and register custom enchantments using the Enchant API. Custom enchantments allow you to extend gameplay with unique effects that trigger based on player actions and configured probabilities.

Core Concepts

APIEnchant Interface

The APIEnchant interface is the foundation of all custom enchantments. It requires implementing the onProc method, which executes when the enchantment activates.

java

public interface APIEnchant {
    void onProc(Player player, EnchantData data);
}

EnchantData System

Enchantment data provides context about the activation trigger:

• EnchantData - Abstract base class for all enchantment data

• CustomEnchantData - Contains mob targeting information (mobId)

Step-by-Step Implementation

1. Create Your Enchantment Class

Implement the APIEnchant interface and define your enchantment's behavior:

java

package com.yourplugin.enchants;

import es.edwardbelt.eddungeons.iapi.enchant.APIEnchant;
import es.edwardbelt.eddungeons.iapi.enchant.EnchantData;
import es.edwardbelt.eddungeons.iapi.enchant.CustomEnchantData;
import org.bukkit.entity.Player;

public class ExampleEnchant implements APIEnchant {
    
    @Override
    public void onProc(Player player, EnchantData data) {
        // Check if this is custom enchant data with mob targeting
        if (data instanceof CustomEnchantData) {
            CustomEnchantData customData = (CustomEnchantData) data;
            
            // Send message with the mob ID data
            player.sendMessage("§6Example enchantment activated! Target mob ID: " + customData.getMobId());
        } else {
            // Handle other types of enchant data
            player.sendMessage("§6Example enchantment activated! Data type: " + data.getClass().getSimpleName());
        }
    }
}

2. Register Your Enchantment

Use the registerEnchant method during plugin initialization:

java

package com.yourplugin;

import es.edwardbelt.eddungeons.iapi.EnchantAPI;
import org.bukkit.plugin.java.JavaPlugin;

public class YourPlugin extends JavaPlugin {
    
    @Override
    public void onEnable() {
        // Get the enchant API instance
        EnchantAPI enchantAPI = EdDungeonsAPI.getInstance().getEnchantAPI();
        
        // Register custom enchantments
        enchantAPI.registerEnchant("example_enchant", new ExampleEnchant());
        
        getLogger().info("Custom enchantments registered successfully!");
    }
}