com.sucy.skill.dynamic.custom.CustomComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proskillapi Show documentation

A Minecraft Bukkit plugin aiming to provide an easy code API and skill editor for all server owners to create unique and fully custom classes and skills.

There is a newer version: 1.3.1-R1

Show newest version

package com.sucy.skill.dynamic.custom;

import com.sucy.skill.dynamic.ComponentType;

import java.util.List;

/**
 * ProSkillAPI © 2023
 * com.sucy.skill.dynamic.custom.CustomComponent
 */
public interface CustomComponent {

    /**
     * @return unique key for your component (what is used in skill .yml files)
     */
    String getKey();

    /**
     * @return type of the component, describing it's general purpose
     * @see ComponentType
     */
    ComponentType getType();

    /**
     * @return A description for your trigger that's shown in the editor
     */
    String getDescription();

    /**
     * @return settings to show in the editor
     */
    List getOptions();

    default String getDisplayName() {
        return getKey();
    }

    default boolean isContainer() {
        return getType() != ComponentType.MECHANIC;
    }
}