IDreamEnchantment.java

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 Dreamfire Studio
 *
 * 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.
 */
package com.dreamfirestudios.dreamcore.DreamEnchantment;
 
import io.papermc.paper.enchantments.EnchantmentRarity;
import io.papermc.paper.registry.set.RegistryKeySet;
import net.kyori.adventure.text.Component;
import org.bukkit.NamespacedKey;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.enchantments.EnchantmentTarget; // legacy but still exposed
import org.bukkit.entity.EntityCategory;
import org.bukkit.entity.EntityType;
import org.bukkit.inventory.EquipmentSlotGroup;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.ItemType;
import org.jetbrains.annotations.NotNull;
 
import java.util.Set;
 
 
public interface IDreamEnchantment {
 
    // ---- Identity / i18n ----
 
 
    @NotNull NamespacedKey getKey();
 
 
    @NotNull String translationKey();
 
 
    @Deprecated @NotNull String getTranslationKey();
 
 
    @Deprecated @NotNull String getName();
 
    // ---- Applicability / items ----
 
 
    @NotNull RegistryKeySet<ItemType> getSupportedItems();
 
 
    @NotNull RegistryKeySet<ItemType> getPrimaryItems();
 
 
    @NotNull Set<EquipmentSlotGroup> getActiveSlotGroups();
 
 
    @Deprecated @NotNull EnchantmentTarget getItemTarget();
 
    // ---- Gameplay attributes ----
 
    int getMaxLevel();
 
    int getStartLevel();
 
    boolean isTreasure();
 
    boolean isCursed();
 
    boolean isTradeable();
 
    boolean isDiscoverable();
 
    int getMinModifiedCost(int level);
 
    int getMaxModifiedCost(int level);
 
    int getAnvilCost();
 
    int getWeight();
 
 
    @Deprecated @NotNull EnchantmentRarity getRarity();
 
 
    float getDamageIncrease(int level, @NotNull EntityCategory category);
 
 
    float getDamageIncrease(int level, @NotNull EntityType type);
 
    // ---- Composition / conflicts ----
 
 
    boolean conflictsWith(Enchantment other);
 
 
    boolean canEnchantItem(@NotNull ItemStack itemStack);
 
 
    @NotNull RegistryKeySet<Enchantment> getExclusiveWith();
 
    // ---- UI / text ----
 
 
    @NotNull Component displayName(int level);
 
 
    @NotNull Component description();
 
    // ---- Convenience helpers ----
 
 
    default @NotNull Enchantment returnEnchantment() {
        return new DreamEnchantWrapper(this);
    }
 
 
    default boolean addToItem(@NotNull ItemStack stack, int level, boolean ignoreLevelRestriction) {
        if (stack.getItemMeta() == null) return false;
        int clamped = Math.max(1, Math.min(level, getMaxLevel()));
        var meta = stack.getItemMeta();
        meta.addEnchant(returnEnchantment(), clamped, ignoreLevelRestriction);
        stack.setItemMeta(meta);
        return stack.getEnchantmentLevel(returnEnchantment()) > 0;
    }
 
 
    default boolean addToItem(@NotNull ItemStack stack) {
        return addToItem(stack, 1, true);
    }
}