OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-30 16:19:03 +01:00
Code Issues Projects Releases Packages Wiki Activity

SPIGOT-7347: Add missing documentation and details to ShapedRecipe

Browse source 
By: Parker Hawke <hawkeboyz2@hotmail.com>
This commit is contained in:
Bukkit/Spigot 2023-05-11 06:52:08 +10:00
parent 1ca237423e
commit 2cc09c8437
1 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
paper-api/src/main/java/org/bukkit/inventory/ShapedRecipe.java
View file

@ -22,6 +22,20 @@ public class ShapedRecipe implements Recipe, Keyed {
private String group = "";
private CraftingBookCategory category = CraftingBookCategory.MISC;
/**
* Create a shaped recipe to craft the specified ItemStack. The
* constructor merely determines the result and type; to set the actual
* recipe, you'll need to call the appropriate methods.
*
* @param result The item you want the recipe to create.
* @see ShapedRecipe#shape(String...)
* @see ShapedRecipe#setIngredient(char, Material)
* @see ShapedRecipe#setIngredient(char, Material, int)
* @see ShapedRecipe#setIngredient(char, MaterialData)
* @see ShapedRecipe#setIngredient(char, RecipeChoice)
* @deprecated Recipes must have keys. Use {@link #ShapedRecipe(NamespacedKey, ItemStack)}
* instead.
*/
@Deprecated
public ShapedRecipe(@NotNull ItemStack result) {
Preconditions.checkArgument(result.getType() != Material.AIR, "Recipe must have non-AIR result.");
@ -40,6 +54,7 @@ public class ShapedRecipe implements Recipe, Keyed {
* @see ShapedRecipe#setIngredient(char, Material)
* @see ShapedRecipe#setIngredient(char, Material, int)
* @see ShapedRecipe#setIngredient(char, MaterialData)
* @see ShapedRecipe#setIngredient(char, RecipeChoice)
*/
public ShapedRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result) {
Preconditions.checkArgument(key != null, "key");
@ -92,10 +107,14 @@ public class ShapedRecipe implements Recipe, Keyed {
/**
* Sets the material that a character in the recipe shape refers to.
* <p>
* Note that before an ingredient can be set, the recipe's shape must be defined
* with {@link #shape(String...)}.
*
* @param key The character that represents the ingredient in the shape.
* @param ingredient The ingredient.
* @return The changed recipe, so you can chain calls.
* @throws IllegalArgumentException if the {@code key} does not appear in the shape.
*/
@NotNull
public ShapedRecipe setIngredient(char key, @NotNull MaterialData ingredient) {
@ -104,10 +123,14 @@ public class ShapedRecipe implements Recipe, Keyed {
/**
* Sets the material that a character in the recipe shape refers to.
* <p>
* Note that before an ingredient can be set, the recipe's shape must be defined
* with {@link #shape(String...)}.
*
* @param key The character that represents the ingredient in the shape.
* @param ingredient The ingredient.
* @return The changed recipe, so you can chain calls.
* @throws IllegalArgumentException if the {@code key} does not appear in the shape.
*/
@NotNull
public ShapedRecipe setIngredient(char key, @NotNull Material ingredient) {
@ -116,11 +139,15 @@ public class ShapedRecipe implements Recipe, Keyed {
/**
* Sets the material that a character in the recipe shape refers to.
* <p>
* Note that before an ingredient can be set, the recipe's shape must be defined
* with {@link #shape(String...)}.
*
* @param key The character that represents the ingredient in the shape.
* @param ingredient The ingredient.
* @param raw The raw material data as an integer.
* @return The changed recipe, so you can chain calls.
* @throws IllegalArgumentException if the {@code key} does not appear in the shape.
* @deprecated Magic value
*/
@Deprecated
@ -137,6 +164,17 @@ public class ShapedRecipe implements Recipe, Keyed {
return this;
}
/**
* Sets the {@link RecipeChoice} that a character in the recipe shape refers to.
* <p>
* Note that before an ingredient can be set, the recipe's shape must be defined
* with {@link #shape(String...)}.
*
* @param key The character that represents the ingredient in the shape.
* @param ingredient The ingredient.
* @return The changed recipe, so you can chain calls.
* @throws IllegalArgumentException if the {@code key} does not appear in the shape.
*/
@NotNull
public ShapedRecipe setIngredient(char key, @NotNull RecipeChoice ingredient) {
Preconditions.checkArgument(ingredients.containsKey(key), "Symbol does not appear in the shape:", key);
@ -163,6 +201,11 @@ public class ShapedRecipe implements Recipe, Keyed {
return result;
}
/**
* Get a copy of the choice map.
*
* @return The mapping of character to ingredients.
*/
@NotNull
public Map<Character, RecipeChoice> getChoiceMap() {
Map<Character, RecipeChoice> result = new HashMap<>();