This file will briefly describe the functionality of this datapack. I intend for this file to be a refresher to myself of how this datapack works whenever I decide to work on it again after a long break.
In order for the cook function to work correctly and efficiently, Chef's Dream uses a specific order of ingredients to minimize the number of checks we have to do to find the recipe. We check the ingredients in this specific order and branch out according to the ingredients we have detected so far. Each branch has an additional branch for each ingredient that can still be added in a valid recipe, and every time we detect a new ingredient, we return/jump to the subbranch for that ingredient. This makes sure that we check the minimal number of ingredients and that no ingredient is checked more than once, keeping our cook function efficient.
Hence, to ensure correctness, it is vital that this specific order is obeyed in all branches of the cook function. If we check for ingredients in a wrong order, we may end up jumping to a wrong branch and not reach the correct recipe. The current order of ingredients is listed below; any new ingredients should preferrably be added to the end of the list so that new ingredient branches do not occur suddenly at the middle of recipes but rather at the end (this also makes changing recipes using new ingredients easier). However, it should be noted that for the sake of making sandwiches, condiments such as ketchup and mustard should try to be maintained at the bottom of the list so that they can be added without invalidating recipes.
- Water
- Potato
- Carrot
- Beetroot
- Bread
- Mushroom
- Porkchop
- Beef
- Chicken
- Mutton
- Rabbit
- Egg
- Dried_Kelp
- Cod
- Salmon
- Pufferfish
- Tropical_Fish
- Apple
- Melon
- Pumpkin
- Glow_Berries
- Chorus_Fruit
- Sugar
- Honey
- Salt
- Flour
- Dough
- Noodles
- Cream_Cheese
- Curry_Powder
- Sausage
- Ham
- Tomato
- Lettuce
- Onion
- Garlic
- Rice
- Paprika
- Sweet_Berries
- Lemon
- Banana
- Chocolate
- Cheese
- Milk
- Orange
- Cocoa Beans
- Sea Pickles
- Bacon
- Kimchi
- Ketchup
- Mustard
The only exception to this rule is with sushi making; in that case, the meats and fish go first in the order listed. Then, all the other ingredients follow in their regular orderings. This is to try to minimize the number of default sushi that gets made from invalid recipes.
When adding a new ingredient, it should be added to the list above. Moreover, the following files will require additions:
ingredients/take.mcfunction: This function is triggered every time an ingredient is removed from a cooking stationingredients/cooking_pot/print_ingredients.mcfunction,ingredients/oven/print_ingredients.mcfunction,ingredients/barrel/print_ingredients.mcfunction: These functions are used to print ingredients present.cook/reset.mcfunction: This function is triggered every time cooking is done to reset the scoreboard objectives.load.mcfunction: This function loads up the scoreboard objective for the ingredients.
The foods, drinks, and uneatable ingredients in this datapack are retextured cookies, potions, and magenta dyes, respectively. The custom texture is applied through the custom_model_data component; see the texture pack for the codes for each food.
For ingredients, a Tags must be added in the custom_data component that states the name of the ingredient so the datapack can easily discern between ingredients. For example, a lemon must have a Tags:["lemon"] inside its custom_data. For ingredients that are in default Minecraft, this is unnecessary.
Functions in the chefsdream:ambience directory deals with sounds and particles created by cooking stations while the player is not interacting with it. For example, the bubbles created by cooking pots or the sounds created by stations while cooking are done by functions in this directory.
To keep track of when to make the sound, a universal timer exists in the global chefsdream:tick function. The objective tick increases by 1 for Tick and resets to 0 every time it reaches 20; once it does, 1 is added to the objective universal_time for Time.
The start_cooking functions in the cook set the tick and universal_time for the cooking station to be equal to the current tick and universal_time. Then, the universal_time for the station is incremented by however long it takes to cook. These variables are used to keep track of when to finish cooking and when to make the sounds in the chefsdream:tick function. Whenever cooking is done, the tick variable for the station is reset to an impossible value (currently 23) so that the tick for the station is never equal to the current tick for Tick.
Functions in the chefsdream:cook directory is responsible for starting the cooking process and finding the food that should be given to the player based on the ingredients put into the cooking station. The directory is further divided into a directory for each station that supports cooking.
To give back bottles whenever bottled ingredients are used in the fryer or the mixer, the give_back_bottles function exists. This function is called by a function corresponding to that bottled ingredient (for example, give_back_ketchup_bottles), which in turn is called by the chefsdream:cook/fryer/cook function and the chefsdream:cook/mixer/cook function. The cooking pot and oven do not need to call this function as giving back the bottles is done while adding the ingredients and there is no way to recover an ingredient already put into a pot or an oven.
Each cooking station in the chefsdream:cook directory has a reset function. This function clears the scoreboard objectives that track ingredients and does anything else necessary to get the cooking station to a state ready to accept new ingredients. (For example, the cooking pot must remove the water inside it.) Adding any new ingredients means that a new scoreboard objective must be reset in each reset function. The reset function MUST be called at the end of the recipe-finding chain initiated by the first cook function for a cooking station.
The scoreboard objectives are kept in the interaction entity that forms the cooking station. The reset function resets the scoreboard objectives for the @s entity, so whenever reset is called, it must be called by the interaction identity using execute as.
Whenever the ingredients added to the cooking station do not match any valid recipe, the default_cook function for that station must be called. This function gives the user a default food for that station, and calls the reset function.
The default_cook function must be called by the player (i.e. @s) since we need to know the entity to give the default food to. Inside default_cook, a call to reset is made as the interaction entity using execute as.
At the beginning of the cook function, the score of the objective check is cleared for @s (the player). Then, in each branch inside the cook function, we increment this check function by the number of the corresponding ingredient for that branch that have been added. For example, if we are currently in a branch for salt, we add ing_salt to check of @s. If we then detect dough and go to the branch salt/dough, we add ing_dough to check of @s.
At the top of any cook function in a branch, the ingredient score of the cooking station corresponding to the most recent ingredient detected must be added to check of @s. Once we have reached a leaf node, we make sure that no other ingredient was added by making sure that the value of @s's check objective matches the value of the cooking staiton's ingredients objective. If they match, no other ingredient have been added, so the food is given. Otherwise, default_cook is called.
The grill is special as the food is not directly given to the player after it has finished cooking. Instead, the cook function simply turns the food on the grill to its cooked version and keeps it there.
The barrel is also special as cooking is done when it is sealed and the results can be taken once enough time has passed. The cook function checks to make sure enough time has passed and then gives the results if so. When the barrel is sealed, the seal function finds the recipe corresponding to the ingredients in the barrel and then seals it for a certain amount of time depending on what is being crafted.
The chefsdream:ingredients directory deals with adding ingredients and interacting with cooking stations that do not directly cook (for example, grinders and plates). They mostly handle clicks (right and left) that occur on the cooking stations.
The directory is further divided into each cooking station. To allow a cooking station to detect a new ingredient, a new function must be added that increments the variable for that ingredient.
The chefsdream:ingredients/check_left_click and chefsdream:ingredients/check_right_click functions detect left clicks and right clicks, respectively, and call the function that corresponds to the station that was interacted with. The exception is that chefsdream:ingredients/check_left_click function calls the chefsdream:station_maker/delete_cooking_station function whenever a left click with a pickaxe is made.
A lot of cooking stations have the shared_add function, which is called by all functions that look like add_(ingredient) after incrementing the correct variable. The shared_add function does anything that adding an ingredient should do for that cooking station, such as making a sound or incrementing the ingredients variable.
The print_ingredients function exists for the cooking pot and oven, and is called when the player interacts with an empty hand. It prints out all the ingredients inside the pot or oven. Whenever a new ingredient is added, a new line must be added to these functions to ensure that they are printed correctly.
The components directory exists for the fryer and mixer. These are used to correctly display the ingredients on the fryer or mixer using item entities. These functions ensure that the ingredient added appears in the correct spot on the station.
The chefsdream:station_maker directory creates a cooking station. Whenever a Cooking Station Maker use is detected in chefsdream:tick, the detect_cooking_station function in this directory is called. This function finds the cooking station that should be created (or none at all) and calls the correct creation function to create the interaction entity that will act as that cooking station.
The hold_pickaxe, hold_shovel, and hold_sword predicates detect whether the player is holding a pickaxe, shovel, or sword, respectively. The is_sneaking predicate detects whether the player is crouching, and can be used in the ingredients directory to differentiate a right click from a crouch right click.
The custom loot tables are given in the minecraft directory inside the datapack, and are used to give custom drops for some blocks. Please look in these loot tables to look at the JSON format for creating new loot tables.
The advancements keep track of custom advancements given to players. These advancements are in the chefsdream/advancements/chefsdream directory and contain JSON documents for the custom advancements. Please look at the JSON documents for a format for creating new advancements.
The custom foods are given their nutritional value through the minecraft:food component. Please look at how a custom food is given in the datapack to get the framework for how to do this. The custom drinks are given their nutritional value through the saturation effect, for which the framework can be found by looking at how a custom drink is given.