diff --git a/docsOut/docs/mods/genericaddon/InfusionRecipeManager.json b/docsOut/docs/mods/genericaddon/InfusionRecipeManager.json deleted file mode 100644 index bbc75df..0000000 --- a/docsOut/docs/mods/genericaddon/InfusionRecipeManager.json +++ /dev/null @@ -1 +0,0 @@ -{"path":"mods/GenericAddon/InfusionRecipeManager.md","zenCodeName":"mods.genericaddon.InfusionRecipeManager","searchTerms":["getRecipeByName","addJsonRecipe","allRecipes","removeByModid","remove","recipeMap","addRecipe","removeAll","removeByName","getRecipeMap","getAllRecipes","removeByInput","getRecipesByOutput","removeByRegex"]} diff --git a/docsOut/docs/mods/genericaddon/InfusionRecipeManager.md b/docsOut/docs/mods/genericaddon/InfusionRecipeManager.md deleted file mode 100644 index f2c1dcd..0000000 --- a/docsOut/docs/mods/genericaddon/InfusionRecipeManager.md +++ /dev/null @@ -1,211 +0,0 @@ -# InfusionRecipeManager - -By default, CraftTweaker creates a [RecipeManagerWrapper](/vanilla/api/recipe/manager/RecipeManagerWrapper) - object per registered **invalid** - unless a mod adds a custom implementation of [IRecipeManager](/vanilla/api/recipe/manager/IRecipeManager)<T>. - - In that case, the implementation will be used. - That is also one of the reasons why you need to implement [this](.)#getRecipeType(). - - The default methods of IRecipeManger already allow you to remove recipes. - They also have a primitive way of getting recipes based on their output. - - If you were to completely remove this class, users would still be able to remove recipes from this type. - We recommend adding a custom manager nonetheless, since you probably also want to _add_ types. - - If you don't need any special logic for recipe removal, you could leave them be and only implement recipe additions. - - In Script, users will be able to call a manager using `` - In this case, `` - -## Importing the class - -It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file. -```zenscript -import mods.genericaddon.InfusionRecipeManager; -``` - - -## Implemented Interfaces -InfusionRecipeManager implements the following interfaces. That means all methods defined in these interfaces are also available in InfusionRecipeManager - -- [IRecipeManager](/vanilla/api/recipe/manager/IRecipeManager)<[InfusionRecipe](/mods/GenericAddon/InfusionRecipe)> - -## Methods - -:::group{name=addJsonRecipe} - -```zenscript -InfusionRecipeManager.addJsonRecipe(name as string, mapData as MapData) -``` - -| Parameter | Type | -|-----------|--------------------------------------| -| name | string | -| mapData | [MapData](/vanilla/api/data/MapData) | - - -::: - -:::group{name=addRecipe} - -Any added methods should be instance methods, - as the recipetype BEP already returns an instance of the manager - - Like for every other method, this documentation will be exported by the Annotation processor - if the AP was added to the compiler's classpath. - -```zenscript -// InfusionRecipeManager.addRecipe(name as string, output as IItemStack, input as IIngredient) - -.addRecipe("my_recipe", * 16, ); -``` - -| Parameter | Type | Description | -|-----------|----------------------------------------------------|-------------------------------------------------------------| -| name | string | The recipe name, only the resource path (without namespace) | -| output | [IItemStack](/vanilla/api/item/IItemStack) | The recipe result | -| input | [IIngredient](/vanilla/api/ingredient/IIngredient) | The recipe's input | - - -::: - -:::group{name=getAllRecipes} - -Return Type: stdlib.List<T> - -```zenscript -// InfusionRecipeManager.getAllRecipes() as stdlib.List - -.getAllRecipes(); -``` - -::: - -:::group{name=getRecipeByName} - -Return Type: T - -```zenscript -InfusionRecipeManager.getRecipeByName(name as string) as T -``` - -| Parameter | Type | -|-----------|--------| -| name | string | - - -::: - -:::group{name=getRecipeMap} - -Return Type: T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)] - -```zenscript -// InfusionRecipeManager.getRecipeMap() as T[ResourceLocation] - -.getRecipeMap(); -``` - -::: - -:::group{name=getRecipesByOutput} - -Return Type: stdlib.List<T> - -```zenscript -InfusionRecipeManager.getRecipesByOutput(output as IIngredient) as stdlib.List -``` - -| Parameter | Type | -|-----------|----------------------------------------------------| -| output | [IIngredient](/vanilla/api/ingredient/IIngredient) | - - -::: - -:::group{name=remove} - -```zenscript -InfusionRecipeManager.remove(output as IIngredient) -``` - -| Parameter | Type | -|-----------|----------------------------------------------------| -| output | [IIngredient](/vanilla/api/ingredient/IIngredient) | - - -::: - -:::group{name=removeAll} - -```zenscript -// InfusionRecipeManager.removeAll() - -.removeAll(); -``` - -::: - -:::group{name=removeByInput} - -```zenscript -InfusionRecipeManager.removeByInput(input as IItemStack) -``` - -| Parameter | Type | -|-----------|--------------------------------------------| -| input | [IItemStack](/vanilla/api/item/IItemStack) | - - -::: - -:::group{name=removeByModid} - -```zenscript -InfusionRecipeManager.removeByModid(modid as string, exclude as Predicate) -``` - -| Parameter | Type | Optional | Default Value | -|-----------|-------------------------|----------|-----------------------------------| -| modid | string | false | | -| exclude | Predicate<string> | true | (name as string) as bool => false | - - -::: - -:::group{name=removeByName} - -```zenscript -InfusionRecipeManager.removeByName(names as string[]) -``` - -| Parameter | Type | -|-----------|----------| -| names | string[] | - - -::: - -:::group{name=removeByRegex} - -```zenscript -InfusionRecipeManager.removeByRegex(regex as string, exclude as Predicate) -``` - -| Parameter | Type | Optional | Default Value | -|-----------|-------------------------|----------|-----------------------------------| -| regex | string | false | | -| exclude | Predicate<string> | true | (name as string) as bool => false | - - -::: - - -## Properties - -| Name | Type | Has Getter | Has Setter | -|------------|---------------------------------------------------------------|------------|------------| -| allRecipes | stdlib.List<T> | true | false | -| recipeMap | T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)] | true | false | - diff --git a/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.json b/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.json deleted file mode 100644 index d1d2c55..0000000 --- a/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.json +++ /dev/null @@ -1 +0,0 @@ -{"path":"mods/GenericAddon/MyStaticIntegrationClass.md","zenCodeName":"mods.genericaddon.MyStaticIntegrationClass","searchTerms":["doPrint"]} diff --git a/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.md b/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.md deleted file mode 100644 index 01e2b97..0000000 --- a/docsOut/docs/mods/genericaddon/MyStaticIntegrationClass.md +++ /dev/null @@ -1,31 +0,0 @@ -# MyStaticIntegrationClass - -A class with static members that allow us to do stuff! - -## Importing the class - -It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file. -```zenscript -import mods.genericaddon.MyStaticIntegrationClass; -``` - - -## Static Methods - -:::group{name=doPrint} - -Prints the given ingredient to the console, yay! - -```zenscript -// MyStaticIntegrationClass.doPrint(ingredient as IIngredient) - -MyStaticIntegrationClass.doPrint(); -``` - -| Parameter | Type | Description | -|------------|----------------------------------------------------|------------------------------| -| ingredient | [IIngredient](/vanilla/api/ingredient/IIngredient) | The ingredient to be printed | - - -::: -