dev.aurelium.auraskills.api.registry.NamespacedRegistry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of auraskills-api Show documentation
Show all versions of auraskills-api Show documentation
API for AuraSkills, the ultra-versatile RPG skills plugin for Minecraft
package dev.aurelium.auraskills.api.registry;
import dev.aurelium.auraskills.api.ability.CustomAbility;
import dev.aurelium.auraskills.api.mana.CustomManaAbility;
import dev.aurelium.auraskills.api.skill.CustomSkill;
import dev.aurelium.auraskills.api.source.SourceType;
import dev.aurelium.auraskills.api.source.XpSourceParser;
import dev.aurelium.auraskills.api.stat.CustomStat;
import dev.aurelium.auraskills.api.trait.CustomTrait;
import org.jetbrains.annotations.NotNull;
import java.io.File;
import java.util.Optional;
public interface NamespacedRegistry {
/**
* Gets the namespace (plugin name) associated with the registry.
*
* @return the namespace
*/
String getNamespace();
/**
* Registers a custom skill in the registry.
*
* @param skill the {@link CustomSkill}
*/
void registerSkill(CustomSkill skill);
/**
* Registers a custom ability in the registry.
*
* @param ability the {@link CustomAbility}
*/
void registerAbility(CustomAbility ability);
/**
* Registers a custom mana ability in the registry.
*
* @param manaAbility the {@link CustomManaAbility}
*/
void registerManaAbility(CustomManaAbility manaAbility);
/**
* Registers a custom stat in the registry.
*
* @param stat the {@link CustomStat}
*/
void registerStat(CustomStat stat);
/**
* Registers a custom trait in the registry.
*
* @param trait the {@link CustomTrait}
*/
void registerTrait(CustomTrait trait);
/**
* Registers a source type in the registry.
*
* @param name The name of the source type in lowercase. Used as the key part of the NamespacedId of the source.
* @param parser the parser for the source
* @return the created {@link SourceType}
*/
SourceType registerSourceType(String name, XpSourceParser> parser);
/**
* Gets the directory from which configuration files are loaded for this namespace.
* This is usually the plugin data folder for the plugin associated with the namespace.
*
* @return the content directory
*/
File getContentDirectory();
/**
* Sets the content directory from which configuration files are loaded for this namespace.
*
* @param contentDirectory the content directory
*/
void setContentDirectory(File contentDirectory);
/**
* Gets the directory where menus are loaded from for this namespace. Menu files with the
* same name as the main plugin are merged together.
*
* @return the menu directory as an optional
*/
@NotNull
Optional getMenuDirectory();
/**
* Sets the directory where menus are loaded for this namespace. Menu files with the
* same name as the main plugin are merged together.
*
* @param menuDirectory the directory
*/
void setMenuDirectory(File menuDirectory);
/**
* Gets the directory where loot tables are loaded from for this namespace. Loot tables
* loaded from the directory are fully separate from default loot tables and must be
* accessed from {@link dev.aurelium.auraskills.api.loot.LootManager} and implemented.
*
* @return the loot directory as an optional
*/
@NotNull
Optional getLootDirectory();
/**
* Sets the loot directory where loot tables are loaded for this namespace. Loot tables
* are loaded fully separate from default loot tables and must be access from
* {@link dev.aurelium.auraskills.api.loot.LootManager} after skills have loaded to be implemented.
*
* @param lootDirectory the loot directory
*/
void setLootDirectory(File lootDirectory);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy