IDreamItemStack.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.DreamItems;
 
import net.kyori.adventure.text.Component;
import org.bukkit.Material;
import org.bukkit.attribute.Attribute;
import org.bukkit.attribute.AttributeModifier;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.inventory.ItemFlag;
import org.bukkit.persistence.PersistentDataContainer;
import org.bukkit.plugin.Plugin;
 
import java.util.*;
 
public interface IDreamItemStack {
 
    /* ------------------ Identity ------------------ */
 
    default Optional<String> id() { return Optional.empty(); }
 
    default Component displayName() { return Component.text(getClass().getSimpleName()); }
 
    default Material type() { return Material.DIAMOND_PICKAXE; }
 
    default int amount() { return 1; }
 
    default OptionalInt customModelData() { return OptionalInt.empty(); }
 
    default boolean unbreakable() { return false; }
 
    /* ------------------ Visuals & extras ------------------ */
 
    default List<Component> lore() { return List.of(); }
 
    default Set<ItemFlag> flags() { return Set.of(); }
 
    default Map<Enchantment, Integer> enchantments() { return Map.of(); }
 
    default Map<Attribute, Collection<AttributeModifier>> attributeModifiers() { return Map.of(); }
 
    default void writePdc(Plugin plugin, PersistentDataContainer pdc) { /* no-op */ }
}