aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/me/shedaniel/rei/api/REIPluginEntry.java')
-rw-r--r--src/main/java/me/shedaniel/rei/api/REIPluginEntry.java49
1 files changed, 49 insertions, 0 deletions
diff --git a/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java b/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
index 786e129a0..8e3063f14 100644
--- a/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
+++ b/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
@@ -2,27 +2,76 @@ package me.shedaniel.rei.api;
import net.minecraft.util.Identifier;
+/**
+ * Get base class of a REI plugin.
+ */
public interface REIPluginEntry {
+ /**
+ * On register of the plugin
+ *
+ * @param pluginDisabler the helper class to disable other plugins
+ */
default void onFirstLoad(PluginDisabler pluginDisabler) {}
+ /**
+ * Registers items on the item panel
+ *
+ * @param itemRegistry the helper class
+ */
default void registerItems(ItemRegistry itemRegistry) {}
+ /**
+ * Registers categories
+ *
+ * @param recipeHelper the helper class
+ */
default void registerPluginCategories(RecipeHelper recipeHelper) {}
+ /**
+ * Registers displays for categories
+ *
+ * @param recipeHelper the helper class
+ */
default void registerRecipeDisplays(RecipeHelper recipeHelper) {}
+ /**
+ * Not called anymore!
+ *
+ * @param recipeHelper
+ * @see REIPluginEntry#registerOthers(RecipeHelper)
+ */
@Deprecated
default void registerSpeedCraft(RecipeHelper recipeHelper) {}
+ /**
+ * Registers bounds handlers
+ *
+ * @param displayHelper the helper class
+ */
default void registerBounds(DisplayHelper displayHelper) {}
+ /**
+ * Register other stuff
+ *
+ * @param recipeHelper the helper class
+ */
default void registerOthers(RecipeHelper recipeHelper) {}
+ /**
+ * Gets the priority of the plugin.
+ *
+ * @return the priority
+ */
default int getPriority() {
return 0;
}
+ /**
+ * Get the identifier of the plugin
+ *
+ * @return the identifier
+ */
Identifier getPluginIdentifier();
}