Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ExNihiloSequentia docs to 1.20.1 #557

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/1.20.1/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"Forge": {},
"Mods": {
"CreateTweaker": {},
"ExNihiloSequentia": {},
"FarmersDelight" : {},
"Initialinventory" : {},
"JeiTweaker": {},
Expand Down
1 change: 1 addition & 0 deletions docs_exported/1.20.1/exnihilosequentia/docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"nav":{"Mods":{"ExNihiloSequentia":{"CompostRecipe":"mods/ExNihiloSequentia/Compost.md","CrushingRecipe":"mods/ExNihiloSequentia/Crushing.md","CrucibleType":"mods/ExNihiloSequentia/ExpandCrucibleType.md","ItemStackWithChance":"mods/ExNihiloSequentia/ExpandItemStackWithChance.md","MeshType":"mods/ExNihiloSequentia/ExpandMeshType.md","MeshWithChance":"mods/ExNihiloSequentia/ExpandMeshWithChance.md","HarvestRecipe":"mods/ExNihiloSequentia/Harvest.md","HeatRecipe":"mods/ExNihiloSequentia/Heat.md","MeltingRecipe":"mods/ExNihiloSequentia/Melting.md","PrecipitateRecipe":"mods/ExNihiloSequentia/Precipitate.md","SiftingRecipe":"mods/ExNihiloSequentia/Sifting.md","SolidifyingRecipe":"mods/ExNihiloSequentia/Solidifying.md","TransitionRecipe":"mods/ExNihiloSequentia/Transition.md"}}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"path":"mods/ExNihiloSequentia/Compost.md","zenCodeName":"mods.exnihilosequentia.CompostRecipe","searchTerms":["getRecipeByName","addJsonRecipe","allRecipes","removeByModid","remove","recipeMap","addRecipe","removeAll","removeByName","getRecipeMap","getAllRecipes","removeByInput","crafttweaker.api.recipe.IRecipeManager","getRecipesByOutput","removeByRegex"]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
# CompostRecipe

## 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.exnihilosequentia.CompostRecipe;
```


## Implemented Interfaces
CompostRecipe implements the following interfaces. That means all methods defined in these interfaces are also available in CompostRecipe

- [IRecipeManager](/vanilla/api/recipe/manager/IRecipeManager)

## Methods

:::group{name=addJsonRecipe}

```zenscript
CompostRecipe.addJsonRecipe(name as string, mapData as MapData)
```

| Parameter | Type |
|-----------|--------------------------------------|
| name | string |
| mapData | [MapData](/vanilla/api/data/MapData) |


:::

:::group{name=addRecipe}

```zenscript
CompostRecipe.addRecipe(name as string, input as IIngredient, amount as int)
```

| Parameter | Type |
|-----------|----------------------------------------------------|
| name | string |
| input | [IIngredient](/vanilla/api/ingredient/IIngredient) |
| amount | int |


:::

:::group{name=getAllRecipes}

Return Type: stdlib.List<T>

```zenscript
// CompostRecipe.getAllRecipes() as stdlib.List<T>

myCompostRecipe.getAllRecipes();
```

:::

:::group{name=getRecipeByName}

Return Type: T

```zenscript
CompostRecipe.getRecipeByName(name as string) as T
```

| Parameter | Type |
|-----------|--------|
| name | string |


:::

:::group{name=getRecipeMap}

Return Type: T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)]

```zenscript
// CompostRecipe.getRecipeMap() as T[ResourceLocation]

myCompostRecipe.getRecipeMap();
```

:::

:::group{name=getRecipesByOutput}

Return Type: stdlib.List&lt;T&gt;

```zenscript
CompostRecipe.getRecipesByOutput(output as IIngredient) as stdlib.List<T>
```

| Parameter | Type |
|-----------|----------------------------------------------------|
| output | [IIngredient](/vanilla/api/ingredient/IIngredient) |


:::

:::group{name=remove}

```zenscript
CompostRecipe.remove(output as IIngredient)
```

| Parameter | Type |
|-----------|----------------------------------------------------|
| output | [IIngredient](/vanilla/api/ingredient/IIngredient) |


:::

:::group{name=removeAll}

```zenscript
// CompostRecipe.removeAll()

myCompostRecipe.removeAll();
```

:::

:::group{name=removeByInput}

```zenscript
CompostRecipe.removeByInput(input as IItemStack)
```

| Parameter | Type |
|-----------|--------------------------------------------|
| input | [IItemStack](/vanilla/api/item/IItemStack) |


:::

:::group{name=removeByModid}

```zenscript
CompostRecipe.removeByModid(modid as string, exclude as Predicate<string>)
```

| Parameter | Type | Optional | Default Value |
|-----------|-------------------------|----------|-----------------------------------|
| modid | string | false | |
| exclude | Predicate&lt;string&gt; | true | (name as string) as bool => false |


:::

:::group{name=removeByName}

```zenscript
CompostRecipe.removeByName(names as string[])
```

| Parameter | Type |
|-----------|----------|
| names | string[] |


:::

:::group{name=removeByRegex}

```zenscript
CompostRecipe.removeByRegex(regex as string, exclude as Predicate<string>)
```

| Parameter | Type | Optional | Default Value |
|-----------|-------------------------|----------|-----------------------------------|
| regex | string | false | |
| exclude | Predicate&lt;string&gt; | true | (name as string) as bool => false |


:::


## Properties

| Name | Type | Has Getter | Has Setter |
|------------|---------------------------------------------------------------|------------|------------|
| allRecipes | stdlib.List&lt;T&gt; | true | false |
| recipeMap | T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)] | true | false |

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"path":"mods/ExNihiloSequentia/Crushing.md","zenCodeName":"mods.exnihilosequentia.CrushingRecipe","searchTerms":["getRecipeByName","addJsonRecipe","allRecipes","removeByModid","remove","recipeMap","addRecipe","removeAll","removeByName","getRecipeMap","getAllRecipes","removeByInput","crafttweaker.api.recipe.IRecipeManager","getRecipesByOutput","removeByRegex"]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
# CrushingRecipe

## 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.exnihilosequentia.CrushingRecipe;
```


## Implemented Interfaces
CrushingRecipe implements the following interfaces. That means all methods defined in these interfaces are also available in CrushingRecipe

- [IRecipeManager](/vanilla/api/recipe/manager/IRecipeManager)

## Methods

:::group{name=addJsonRecipe}

```zenscript
CrushingRecipe.addJsonRecipe(name as string, mapData as MapData)
```

| Parameter | Type |
|-----------|--------------------------------------|
| name | string |
| mapData | [MapData](/vanilla/api/data/MapData) |


:::

:::group{name=addRecipe}

```zenscript
CrushingRecipe.addRecipe(name as string, input as IIngredient, drops as ItemStackWithChance[])
```

| Parameter | Type |
|-----------|----------------------------------------------------------------------------|
| name | string |
| input | [IIngredient](/vanilla/api/ingredient/IIngredient) |
| drops | [ItemStackWithChance](/mods/ExNihiloSequentia/ExpandItemStackWithChance)[] |


:::

:::group{name=getAllRecipes}

Return Type: stdlib.List&lt;T&gt;

```zenscript
// CrushingRecipe.getAllRecipes() as stdlib.List<T>

myCrushingRecipe.getAllRecipes();
```

:::

:::group{name=getRecipeByName}

Return Type: T

```zenscript
CrushingRecipe.getRecipeByName(name as string) as T
```

| Parameter | Type |
|-----------|--------|
| name | string |


:::

:::group{name=getRecipeMap}

Return Type: T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)]

```zenscript
// CrushingRecipe.getRecipeMap() as T[ResourceLocation]

myCrushingRecipe.getRecipeMap();
```

:::

:::group{name=getRecipesByOutput}

Return Type: stdlib.List&lt;T&gt;

```zenscript
CrushingRecipe.getRecipesByOutput(output as IIngredient) as stdlib.List<T>
```

| Parameter | Type |
|-----------|----------------------------------------------------|
| output | [IIngredient](/vanilla/api/ingredient/IIngredient) |


:::

:::group{name=remove}

```zenscript
CrushingRecipe.remove(output as IIngredient)
```

| Parameter | Type |
|-----------|----------------------------------------------------|
| output | [IIngredient](/vanilla/api/ingredient/IIngredient) |


:::

:::group{name=removeAll}

```zenscript
// CrushingRecipe.removeAll()

myCrushingRecipe.removeAll();
```

:::

:::group{name=removeByInput}

```zenscript
CrushingRecipe.removeByInput(input as IItemStack)
```

| Parameter | Type |
|-----------|--------------------------------------------|
| input | [IItemStack](/vanilla/api/item/IItemStack) |


:::

:::group{name=removeByModid}

```zenscript
CrushingRecipe.removeByModid(modid as string, exclude as Predicate<string>)
```

| Parameter | Type | Optional | Default Value |
|-----------|-------------------------|----------|-----------------------------------|
| modid | string | false | |
| exclude | Predicate&lt;string&gt; | true | (name as string) as bool => false |


:::

:::group{name=removeByName}

```zenscript
CrushingRecipe.removeByName(names as string[])
```

| Parameter | Type |
|-----------|----------|
| names | string[] |


:::

:::group{name=removeByRegex}

```zenscript
CrushingRecipe.removeByRegex(regex as string, exclude as Predicate<string>)
```

| Parameter | Type | Optional | Default Value |
|-----------|-------------------------|----------|-----------------------------------|
| regex | string | false | |
| exclude | Predicate&lt;string&gt; | true | (name as string) as bool => false |


:::


## Properties

| Name | Type | Has Getter | Has Setter |
|------------|---------------------------------------------------------------|------------|------------|
| allRecipes | stdlib.List&lt;T&gt; | true | false |
| recipeMap | T[[ResourceLocation](/vanilla/api/resource/ResourceLocation)] | true | false |

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"path":"mods/ExNihiloSequentia/ExpandCrucibleType.md","zenCodeName":"mods.exnihilosequentia.CrucibleType","searchTerms":["fired","FIRED","WOOD","wood"]}
Loading