diff options
Diffstat (limited to 'src/main/java/me/shedaniel/rei/api/RecipeHelper.java')
| -rw-r--r-- | src/main/java/me/shedaniel/rei/api/RecipeHelper.java | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/main/java/me/shedaniel/rei/api/RecipeHelper.java b/src/main/java/me/shedaniel/rei/api/RecipeHelper.java index 4b0fde018..58d67e97a 100644 --- a/src/main/java/me/shedaniel/rei/api/RecipeHelper.java +++ b/src/main/java/me/shedaniel/rei/api/RecipeHelper.java @@ -1,3 +1,8 @@ +/* + * Roughly Enough Items by Danielshe. + * Licensed under the MIT License. + */ + package me.shedaniel.rei.api; import me.shedaniel.rei.RoughlyEnoughItemsCore; @@ -12,6 +17,9 @@ import java.util.Optional; public interface RecipeHelper { + /** + * @return the api instance of {@link me.shedaniel.rei.client.RecipeHelperImpl} + */ static RecipeHelper getInstance() { return RoughlyEnoughItemsCore.getRecipeHelper(); } @@ -22,14 +30,34 @@ public interface RecipeHelper { List<ItemStack> findCraftableByItems(List<ItemStack> inventoryItems); + /** + * Registers a category + * + * @param category the category to register + */ void registerCategory(RecipeCategory category); + /** + * Registers a recipe display + * + * @param categoryIdentifier the category to display in + * @param display the recipe display + */ void registerDisplay(Identifier categoryIdentifier, RecipeDisplay display); Map<RecipeCategory, List<RecipeDisplay>> getRecipesFor(ItemStack stack); + /** + * Gets the vanilla recipe manager + * + * @return the recipe manager + */ RecipeManager getRecipeManager(); + /** + * Gets all registered categories + * @return the list of categories + */ List<RecipeCategory> getAllCategories(); Map<RecipeCategory, List<RecipeDisplay>> getUsagesFor(ItemStack stack); |
